フレームワークgoto定義はコメントを表示しますが、これらはxmlコメントから生成されますか？

Question

最近、注意深く作成されたxmlコメントが同僚のインテリセンスに表示されないことを発見して、少し驚きました。関連するアセンブリを常にプロジェクト参照とともに使用していたため、この情報にアクセスするには.xmlドキュメントもエクスポートする必要があることに気づきませんでした。

これにより、.Netフレームワークのインテリセンスがどのように機能するのか疑問に思いました。正しく理解できれば、.xmlファイルは特別なフォルダーのどこかに隠しておく必要がありますか？

しかし、私の主な質問は「後藤定義」です..Netフレームワークアセンブリの定義に移動すると、メタデータから生成された情報を取得します-有益なコメントもたくさんあります-これらは魔法のようにXmlコメントから生成されますか、または誰かがビルドのためにそれらを変換するためにマクロを書く必要がありましたか？別の言い方をすれば、どのようにアセンブリにこの効果を得ることができますか？

Answer 1

プロジェクトはXMLドキュメントを生成するように設定されていますか？ソースコードにコメントを追加したからといって、指示がない限り、コンパイラは.xmlファイルを生成しません。

プロジェクトのプロパティページで、[ビルド]に移動します。タブをクリックして、「出力」を見てください。セクション。 「XMLドキュメントファイル」というタイトルのチェックボックスエントリが表示されます。そのチェックボックスに続くテキストボックスが空の場合、XMLドキュメントファイルを生成していません。

XMLドキュメントファイルを生成すると、IntelliSenseツールチップにコメントが表示されます。他のプロジェクトへの参照をプロジェクト参照として含めると、これは自動的に行われます。アセンブリへの参照を含める場合、xmlファイルが参照アセンブリと同じ場所にあることを確認する必要があります。 （ビルド時に、それぞれbin / debugまたはbin / releaseフォルダーにあるすべてのアセンブリのxmlファイルを取得する必要があります。）

.NET Frameworkアセンブリ自体については、対応するxmlドキュメントファイルがFrameworkの一部としてインストールされます。 .NET 2.0、3.0、または3.5の場合、ドキュメントファイルは C：\ Windows \ Microsoft.NET \ Framework \ v2.0.50727 \ en にあります（フレームワークのデフォルトのインストールを前提としています）。これらのファイルは、IntelliSenseツールチップと「定義に移動」の両方で使用されます。この情報を表示するためのVisual Studioの機能。これを実現するために行われる特別な処理やマクロの実行はありません。 Visual Studioが使用する可能性が最も高い唯一の情報は、ドキュメントファイルへの正しいパスを決定するレジストリキーの組み合わせです。

おそらく、同じフォルダー内で独自のアセンブリのxmlドキュメントファイルを見つけることができますが、Framework以外の関連ファイルでFrameworkのインストールを汚染するため、そうしないことをお勧めします。