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

はじめに

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

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

seeタグを利用している様子

概要

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

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

Riderでの表示

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>で詳細は検索してください。

hrefを利用している様子

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

参考

クラスとそのメンバー用として推奨される XML ドキュメント タグ | Microsoft Learn