C# XMLコメント チートシート

内容

たまにC#のコメント細かく書きたいときにどんなタグがあった思い出すために作成。

タグ	説明
<summary>	型やメンバー関する情報を記述
<remarks>	型やメンバーに関する情報を補足する。<summary>の補足情報を記載する
<returns>	メソッドの戻り値
<value>	プロパティに対して使用する。returnsと同じ
<example>	例を挿入する<code>を入れ子で使用する
<para>	書式設定タグ<remarks> や <returns>の内側で使用してテキストを段落に分割するときなど
<c>	書式設定タグテキストの一部をコードとしてマークする<code>のインライン用途
<exception cref="Exception">	メソッドでの例外されるスローを記述
<see cref="Math.Add(int, int)">	別のコード要素のドキュメント ページへのクリック可能なリンクを作成
<seealso>	<see> と同じように使用
<param>	メソッドのパラメーターを記述
<typeparam>	ジェネリック型またはメソッド宣言で、ジェネリック パラメーターを記述するために使用

<remark> の記述例

/// <summary>
/// チート例に関するクラス
/// </summary>
/// <remarks>
/// C#コメントタグに対する使用例を取得できます
/// </remarks>
public class CheatExample
{
    public CheatExample(string tag)
    {
        ...
    }
}

<example>の記述例

/// <summary>
/// チート例に関するクラス
/// </summary>
/// <example>
/// <code>
/// {
///     var commentExample = new CheatExample("summary");
///     var sampleComment = commentExample.Get();    
///     Console.WriteLine(sampleComment);
/// }
/// </code>
///<example>
public class CheatExample
{
    public CheatExample(string tag)
    {
        ...
    }

    public string Get()
    {...}
}

各使用例は、参考URLが詳しいので以下を御覧ください。

---

参考URL

XML コメントによるコードの文書化
XML ドキュメント コメント (C# プログラミング ガイド)