【C#】XMLタグのseeタグを用いてコメント内からリンクを生成する

今回はXMLタグのseeタグについて取り上げたいと思います。

/// <summary>
/// <see cref="HogeClass"/>はとても凄いクラスです。
/// </summary>
public class SampleClass

XMLタグのseeタグを利用することで、テキスト内からリンクを生成することができます。

/// <summary>
/// <see cref="GameObject"/>を利用しているクラスです。
/// </summary>
public class SampleClass { }

RiderならF12(macならfn + F12)を押すことで、定義に飛ぶことができます。

crefにメンバーまたはフィールドへの参照を記載します。

<see cref="member or field"/>

Riderの場合はちゃんと候補が出てきてくれます。

ただジェネリック型の場合は少し変な書き方をするので注意です。

<see cref="HogeClass{T}/>

またhrefを用いることで、特定のURLへのクリック可能なリンクを記載することができます。

<see href="https://www.google.com/">Google</see>で詳細は検索してください。

DocFXでもちゃんと反映されるみたいなので、ぜひ積極的に利用してみてください。

はなちるのマイノート