問題タブ [xml-documentation]

基本的に、私は次のコードを持っています：

MyProject.XML

サンドキャッスルの構築された出力：

警告：ShowMissingComponent：M：MyProject.MyDictionary`2.System＃Collections＃Generic＃ICollection{T}#Clearのドキュメントがありません

だから、ここで正確に何をすべきかわからない。Sandcastleビルドオプションに明示的な実装を含めたので、ドキュメントにそれらのページが作成されましたが、このメソッドのXMLコメントを作成したことを理解できないようです。奇妙なことに、このvoid MyDictionary<TKey, TValue>.IDictionary<TKey, TValue>.Add(TKek key, TValue value)メソッドはXMLコメントを持っていると識別されます。実際、暗黙的に実装されたICollection>メソッドはすべて、Sandcastleに問題を引き起こしています。何か助けはありますか？

JavaScript 用のコメント ドキュメント形式と、HTML ドキュメントを生成するこの形式用のプロセッサはありますか?

現在、開発時に IntelliSense ヘルプを提供するために VSDoc xml コメントを使用していますが、私が知っているように、そのようなコメント用のドキュメント ジェネレーターはありません。代わりに、私の質問は次のように聞こえるかもしれません: VSDoc コメントを JavaScript ファイルから HTML に変換するユーティリティはありますか?

.NET 関数に付属する C# のメソッドの XML ドキュメントを追加するにはどうすればよいですか。

例

Guid.NewGuid();

ユーザーが を押したとき。key 彼は、関数 NewGuid が何をするかについてのヘルプを取得します。

getDocTag のような関数を持つクラス GetDocsInfo があり、同様の機能が必要です。属性のように追加する必要があるメタデータの種類はありますか

Sandcastleヘルプファイルビルダーを使用して、C＃XML-DOCファイルをWebサイト形式に出力しています。実際のプロジェクトをビルドするときにVisualStudioでビルドイベントとしてこれを追加できるように、コマンドラインから同じことをどのように実行できますか？

最終的な目標は、VisualStudioプロジェクトをビルドするときにWebサイトのヘルプファイルのコンテンツをビルドすることです。

がある

クラスまたはメソッドのドキュメント。しかし、単純な変数またはリストに対してこれをどのように書くのでしょうか？

私はVisualStudio2010を使用しており、リスト、プロパティ、またはある種の要約（その小さなツールチップ内）を見たいものにカーソルを合わせると、その特定のものに書き込みました。

編集：わかりました、クラス内のuコメントがあれば通常どおり機能しますが、メソッドまたは関数の外にあることがわかりました。

メソッド内で文書化/コメントする方法もありますか？

最初にロードしてから同じファイルパスと名前で保存するときに、xmlファイルを変更する際に問題が発生します。以下は私のコードです。エラーは「パスC：\ MyApp \ Web.configへのアクセスが拒否されました。xdoc.Saveのパスをxdoc.Loadとは異なるものに変更すると、問題ありません。これを解決するための推奨事項は何ですか。問題？可能であれば、既存のxmlファイルを変更する必要があります（ロードと保存のxmlファイルが同じパスであることを意味します）。

前もって感謝します。

Visual Studioで、デフォルトのXMLサマリーコメントスニペットを3行から1行に変更するにはどうすればよいですか？

現在、次のように入力すると、このスニペットが提供されます///。

この短いスニペットが欲しいです：

私の要約はしばしば簡潔であり、余分な2行は不要です。

これまたはこれを修正するためのカスタマイズ可能なコード/カスタムアドオンの構成設定はありますか？

codeproject.com のフレームワークを使用します。パッケージには .dll ファイルと .xml ファイルがあります。dll ファイルを使用してプロジェクトに追加し、そのAdd Reference...場所を参照しました。参照に追加され、コードでそれを指すことができますusing ....

2 つの質問があります。

1. メソッドなどのコメントと思われる XML ファイルがパッケージに含まれています。どうすればこれを使用できますか? (そのフレームワークからメソッド名を入力すると、その説明がポップアップ表示されますか?)

2. プロジェクトのインストールをビルドするときに、dll ファイルがそこに含まれていることを確認するにはどうすればよいですか?

重複の可能性:
XML コメントを別のプロジェクト (dll) に表示するにはどうすればよいですか?

私は1つのライブラリのソースコードを持っており、すべての変数、メソッドなどはそこにコメントされています

このプロジェクトをビルドし、別のプロジェクトで dll ファイルとして使用したいのですが、参照を追加すると、変数の説明などが表示されません。何が間違っていますか?

• Code Contracts ver: 1.4.40602.0 を使用しています。
• 必要なコンテンツと変換ファイルをコピーしました
• サンドキャッスルは、契約要件に基づいて例外を出力します

コード例:

結果の出力（私のドキュメント内）：

これはそれほど悪くはありませんが、Condition のテキストをカスタマイズする方法はあるのでしょうか? ユーザー メッセージを追加しようとしましたが、Contract.Requires<ArgumentNullException>(obj != null, "obj is null.");何も解決しませんでした。

以前は、例外用に独自の xml ドキュメント セクションを作成する必要がありました。必要なものを得るために、もう一度それをしなければならないのでしょうか?

免責事項: Code Contracts は (現在) DevLabs プロジェクトであるため、これは変更される可能性がありますが、現在既に利用可能であるかどうか疑問に思っています...そうでない場合は、必ず提案します.