問題タブ [sandcastle]

APIドキュメントの生成に使用されるツールが部分クラスに対するXMLスタイルのコメントを持つことを処理する標準的な方法はありますか？基本的に、結果のヘルプドキュメントが壊れないように、部分的なクラス/メソッドにどのようにコメントする必要がありますか？この質問は、使用するツールによって異なる可能性があります。その場合、最も重要な2つのツールは次のとおりです。

• XMLドキュメントを作成するためのVisualStudioの組み込みメソッド
• マイクロソフトのサンドキャッスル

XMLドキュメントをファンキーに見せたくないのはすべてです

基本的に、完全修飾xmlを使用することが本当に必要なのはいつですか（あるとしても）。リファレンスを参照してください。

また、.NETFrameworkオブジェクトへの参照についてはどうでしょうか。

完全に適格なアイテムは常にMicrosoftのSandcastleが物事を適切にリンクできるようになることを理解していますが、すべてが完全に適格である必要がありますか？

補足：MicrosoftSandcastleは.NETFrameworkヘルプファイルにリンクできますか、それとも参照して時間を無駄にしています<see cref="T:System.Collections.Generic.ICollection{T}"/>か？

///クラス、フィールド、メソッド、またはプロパティを超えると、VisualStudioがXMLスタイルのコメントの作成を開始することを理解しています。

ただし、名前空間やライブラリのXMLコメントを追加するにはどこに行けばよいですか...

例えば：

• .NETFrameworkクラスライブラリ
  • System.Collections名前空間
    1. System.Collections名前空間
    2. System.Collections.Concurrent名前空間
    3. ..。

それらのページが手動で作成されたのか、それとも適切な場所に追加されたXMLスタイルのコメントを介して自動的に作成されたのかわかりません。

重複の可能性:
C# の <seealso> タグでメソッド オーバーロードへのクレフを作成する方法は?

個々のメソッドではなく、このようなものを指すように、コードに XML コメントを付けるにはどうすればよいですか? ComputeHash オーバーロード

cref基本的に、MSDN と同じようにメソッド オーバーロード ページを参照するには、何を入力すればよいでしょうか。

Sandcastle Help File Builderを使用していますが、「概念コンテンツ」に色付きのHTMLコードスニペットを含めたいと思います。これは可能ですか？もしそうなら、どのように？

<code>、<codeExample>、および<sampleCode language ="HTML"/>を試しました。

これまでのところ最良の結果は、サンプルHTMLをHTMLエンコードし、そのように.snippetsファイルに配置することです。

次に、.amlファイルでそれを参照します。

色付けしたいのですが、フォーマットを追加する方法がわかりません。

クラスがインターフェースで定義されたメソッドを実装する場合、ドキュメントを複製するか、で参照するかを選択できます<see cref="..." />。

APIドキュメントツール（Sandcastle）にドキュメントを自動的にコピーさせることは可能ですか（APIドキュメントをより快適に読むために何が必要ですか）？@inheritDocJava Docのようなものですか？

私はオープンソースプロジェクト（ここ）を持っており、そのドキュメントは現在フランス語です。ドキュメントは、Sandcastleを使用して、コード内のXMLコメントから生成されます。今、私はドキュメントを英語に翻訳し、両方の言語でドキュメントを提供したいと思いますが、どこから始めればよいのか本当にわかりません...

• コードからXMLコメントを抽出して、別のファイルに入れる必要がありますか？はいの場合、プロセスを自動化するためのツールはありますか？
• Sandcastle HelpFileBuilderを使用してドキュメントを作成しています。英語でドキュメントを作成するために別のプロジェクトを作成する必要がありますか、それとも同じプロジェクトから作成できますか？
• 翻訳プロセスに役立つツールはありますか？たとえば、元のドキュメントと翻訳されたドキュメントを並べて表示しますか？

また、Googleで役立つものが見つからなかったため、多言語ドキュメントの作成方法に関するリンクにも興味があります...

さて、いくつかのクラスを含むアセンブリと、いくつかのメソッドを含むインターフェイスがあります

このアセンブリで SandCastle を実行すると、必要なドキュメントが生成されますが、インターフェイスのメソッドに移動すると、パラメーターの場合のように戻り値の型がドキュメント化されません。

私の推測では、スタイル ファイルまたは何かで何かが間違っていると思いますが、どのファイルを編集すればよいかわからないので、何が欠けているのでしょうか?

アップデート：

使用しています

• Sandcastle ヘルプ ファイル ビルダ ユーティリティ、バージョン 1.9.3.0
• Sandcastle - 2010 年 6 月リリース (バージョン 2.6.1062.1)
• Sandcastle スタイル 2010 年 6 月 (2.6.10621.1) - Rev 1

さて、タイトルはそれをすべて尋ねます。

Sandcastle Help File Builder GUI を持っています。ヘルプ ファイルを生成することはできますが、ヘルプ ファイル全体を再コンパイルする以外に、結果をより速く表示する方法があるかどうか疑問に思っていました。

Sandcastle について尋ねたのは、私が試したプレビュー機能を提供する他のツールが、Sandcastle のようにヘルプ ファイルを正確な仕様にコンパイルしないためです。それらのほとんどは、完全に修飾された参照を必要としますが、これはお尻の痛みです。

クラス参照用のドキュメントを生成するために、nDocからSandCastleに移行しています。nDocは.net2.0をサポートしておらず、他にも多くの制限があります。

以前、nDocを使用すると、クラス名の強調表示など、コードに素敵な色を適用することができました。

たとえば、異なる色でConsole.WriteLine(something)表示Consoleされます（nDocではHTMLスタイルをXMLで直接指定できるため）。

ただし、Sand Castle（MAML）は型名を無視しているようです（実際のC＃コードのみを受け入れ、色付けのHTML属性は許可されておらず、色付けはSand Castle自体によって実行されます）。最終的には、キーワード、コメント、定数のみが色付けされます。タイプ名も色付けされるようにこれを修正できますか？ありがとう！

以下は、私がnDocで持っていたものと、Sand Castleで複製する必要があるものです（MailMessage、Pop3およびConsoleが強調表示されています）。