パッケージ内のIntelliSenseとトリプルスラッシュのコメント

Question

私は完全に文書化する時間を費やしたコードライブラリを開発しました。

クラス、メソッド、プロパティは、トリプルスラッシュXML（xmldoc）コメントを使用したコメントです。私はDLLファイルにこれをコンパイルして、私の他のプロジェクトからそれを参照、または私が参照NuGetパッケージとしてそれをパッケージ化するとき

/// <summary> 
/// Adds two numbers together. 
/// </summary> 
/// <param name="a">The first number.</param> 
/// <param name="b">The second number.</param> 
/// <returns>The sum.</returns> 
public int Add(int a, int b) 
{ 
    return a + b; 
} 

しかし、その後、Visual Studioの/ IntelliSenseが私のライブラリのすべてのドキュメントを提供していません。

これはなぜですか、これについては何ができますか？

Answer 1

あなたの問題を解決するが、xmlドキュメントファイルの生成を試したことがあるかどうかは100％はわかりません。これがDLLと一緒にパッケージ化されていれば、intelliSenseで取得できます。

Answer 2

コンパイラは直接のIntelliSenseは、任意のドキュメントを提供するためにそのことはできないその.DLLによってアセンブリを参照するとき、従って、得られたコメントからのすべてのコメントを削除します。

プロジェクトプロパティで「XMLドキュメントファイル」を出力できるようにすると、コンパイルされた.dllファイルに加えて.xmlファイルが出力されます。 NuGetを使用してパッケージを作成する場合（dotnet pack -c releaseを使用して作成した場合）、XMLドキュメンテーションファイルが含まれているため、NuGetを使用してインストールされたパッケージはIntelliSenseにドキュメントを提供します。