DOBON.NET プログラミング道: .NET Framework, VB.NET, C#, Visual Basic, Visual Studio, インストーラ, ...
DOBON.NET > プログラミング道 > .NET Tips > Visual Studio

IntelliSenseで自作クラスのメンバの説明を表示する

Visual Studio .NETの機能であるIntelliSenseのクイックヒントや、メンバの一覧、パラメータヒントなどで、自作クラスやそのメンバ、パラメータの説明を表示するために、ソースコード内にXMLドキュメントコメント（「ドキュメントコメントにより型の概要をXMLファイルに出力する」を参照）を記述することができます。（この方法はVisual Studio 2003以前では、C#のみに対応しています。）「ドキュメントコメントとして推奨されているタグ」のうち、IntelliSenseで表示されるものは、<summary>（説明）と<param>（パラメータの説明）です。ヘルプによると、このうち<summary>タグのテキストは、IntelliSenseの型に関する唯一の情報源とのことです。

例えば、"TestClass"という名前のクラスに次のようなメソッドがあった場合、

VB.NET
コードを隠すコードを選択
''' <summary>
''' 指定した値を合計値に加算します。
''' </summary>
''' <param name="val">加算する整数</param>
Public Shared Function Plus(ByVal val As Integer) As Integer
End Function
C#
コードを隠すコードを選択
/// <summary>
/// 指定した値を合計値に加算します。
/// </summary>
/// <param name="val">加算する整数</param>
public static int Plus(int val)
{
}

Visual Studio .NETのエディタで、クイックヒントは下図のように表示され、

パラメータヒントは下図のように表示されます。

また、クラスライブラリなどのアセンブリを参照して使用するときは、「ドキュメントコメントにより型の概要をXMLファイルに出力する」で紹介したXMLドキュメントをアセンブリと同じファイル名で、アセンブリと同じフォルダに置くことにより（つまり、例えば"ClassLibrary1.dll"という名前のアセンブリの場合、"ClassLibrary1.xml"という名前のXMLファイルを用意する）、IntelliSenseで使用されるようになります。（この方法は、Visual Studio 2003以前のVB.NETでも使用できます。）

  • 履歴：
  • 2007/2/5 .NET Framework 2.0に関する記述を追加。

（この記事は、「.NETプログラミング研究 第36号」で紹介したものです。）