1. Home
›
2. C#
›
3. XMLドキュメントコメント

C# XMLドキュメントコメント

概要

コメントを指定の記法で記述することにより、コンパイラによるXMLドキュメントの生成、Visual Studio の IntelliSense で情報を表示する際に参照、外部ツールでHTML等のドキュメント生成時に利用等が可能になります。

公式ドキュメント

https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments

記述例

通常の単一行コメントであるスラッシュ2つに対し、スラッシュ3つの後に特定のタグを記述します。

以下の例では関数1つを持つクラスの定義に対し、TestClassとTestMethod前にそれぞれドキュメントコメントを記載しています。

使用しているタグは、オブジェクトの概要をあらわす<summary>タグで、タグ内に概要を記載しています。

/// <summary>
/// テストクラス
/// </summary>
public class TestClass
{
  /// <summary>
  /// テスト関数
  /// </summary>
  public void TestMethod()
  {
  }
}

タグ一覧

タグ	説明
<c>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/code-inline
<code>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/code
<example>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/example
<exception>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/exception
<include>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/include
<list>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/list
<para>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/para
<param>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/param
<paramref>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/paramref
<permission>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/permission
<remarks>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/remarks
<returns>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/returns
<see>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/see
<seealso>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/seealso
<summary>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/summary
<typeparam>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/typeparam
<typeparamref>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/typeparamref
<value>	https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/xmldoc/value

doxygen version 1.8.15で確認。

以下のような場合に2つめの<c>タグがそのまま出力される。

/// <value><c>true</c>の場合は〜。 <c>false</c>の場合は〜。</value>

出力結果

trueの場合は〜。 <c>falseの場合は〜。