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

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

Visual Studioには、クラスやメンバの情報を表示することができる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のエディタでクイックヒントが下図のように表示されます。

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

上記のコードをビルドして作成したアセンブリを使うと、ヒントが表示されません。この場合にヒントを表示するには、「ドキュメントコメントにより型の概要をXMLファイルに出力する」の方法でXMLファイルを作成し、そのファイル名をアセンブリと同じファイル名(例えば、アセンブリが「test.dll」ならば、「test.xml」)にして、アセンブリと同じフォルダに置きます。

ドキュメントコメントについてより詳しくは、「ドキュメントコメントにより型の概要をXMLファイルに出力する」をご覧ください。

注意:この記事では、基本的な事柄の説明が省略されているかもしれません。初心者の方は、特に以下の点にご注意ください。

  • .NET Tipsをご利用いただく際は、注意事項をお守りください。