[C#] XMLドキュメントコメントの書き方について

Question

使用環境: Visual Studio Community 2015

こんばんは。初めての投稿なのでトンチンカンなことを言っていたらすみません。

Visual StudioでXMLドキュメントコメントが表示される際に自作クラス名等を色付きで表示させる（というか識別させる）にはどのように記述すればよろしいのでしょうか？

下記画像にある説明文「ある要素が～」のすぐ後にある "List<T>" のようにしたいです。

Answer 1

<see>タグのcref 属性を使用します。
詳しくはプログラミングガイドのドキュメント コメント用の推奨タグ、および、cref 属性の説明を参照してください。

コード例

/// <summary>
/// このメソッドは<see cref="MyClass"/>オブジェクトをなんとかします。
/// </summary>
public void DoSomething(MyClass mc)
{
}

DoSomethingのクイックヒントで、コメントのMyClass部分に型であることを示す色が付きます。List<T>のようなジェネリックの場合は<see cref="List{T}"/>のように記述します。

似たようなタグに<seealso>というのがありますが、そっちは「参照」で、「これも見てください」というような意味になります。

Comments

[RQN]

ありがとうございました！とても分かりやすく教えていただき助かりました。