プログラマーな日々

I'm a Cloud Architect and Developer, and a trainee of the network engineer training course. I have certified by AWS and Cisco (SAA/SOA/DVA/CCNA). I especially have highly motivated to reduce toils.

XML形式のドキュメントコメントにジェネリック型へのリンクを設定する

XML形式のコメントにジェネリック型へのリンクを設定したいときがあります。
例えば、こんな具合です。

<see cref="System.Collections.Generic.List<T>"/>

でもXMLなので「」を記述するとエラーになります。

解決方法

実体参照を使います。こんな具合です。

<see cref="System.Collections.Generic.List&lt;T&gt;"/>

サンプルコードも

<example>
<code>
int i = 1;
if (i < hoge) {
    Console.Write("iはhogeより小さい");
}
</code>
</example>

不等号は実体参照で記述します。

<example>
<code>
int i = 1;
if (i &lt; hoge) {
    Console.Write("iはhogeより小さい");
}
</code>
</example>