【VisualStudio】使用DLLのXMLコメントを見れるようにする

はじめに

開発をしていれば、共通ライブラリの開発などをしていくと思います。

その共通ライブラリを使用する人がコメントを見れないのは残念ですよね。現場ではXMLコメントを使用していながら、他ソリューションで使用したらコメント見れないなんてことが多発してました。。。何のためにコメントを付けたのでしょうか。。。

なので、XMLコメントを見れるようにするための設定方法をまとめていきます。

使用環境

・Visual Studio 2022

サンプルコードに関して

• Class1
  • Fooと出力するメソッド
  • こちらはクラスライブラリで作成します

これをコンソールアプリケーション上(Program.cs)で呼び出します。

Class1.cs

	/// <summary>
	/// クラス1
	/// </summary>
	public sealed class Class1
	{
		/// <summary>コンストラクタ</summary>
		public Class1(){}

		/// <summary>コンソールにFooと出力します。</summary>
		public void Foo() 
		{
			Console.WriteLine("Foo"); 
		}
	}
}

Program.cs

using Sample;

var class1 = new Class1();
class1.Foo(); //output:Foo
}

何も設定せずにただ参照追加

• 「コンストラクタ」と記載したはずのコメントが見れません。

設定方法

1. プロジェクトを右クリック　＞　プロパティ　を選択
   

2. ビルド　＞　出力　＞ドキュメントファイルにチェック
   

3. これでビルドし直して、新しくできたDLLを参照するように変更します
   

• XMLコメントが見れるようになりましたね！！

以上、VisualStudio上でXMLコメントを見れるようにするための設定方法でした。

以下、参考文献となります。