C# for Visual Studio Code（powered by OmniSharp）は、v1.23.8（2020/12/18）から ドキュメントコメントが正式にサポートされました。
これは設定のEditor: Format On Typeをオンにすることで有効になります。
本記事ではドキュメントコメントである <see> タグの cref 属性を使って C# コード内へのハイパーリンクを作成する方法を紹介します。
目次
この記事でのバージョン情報
Visual Studio Code 1.53.1
ドキュメントコメントとは
ドキュメントコメントとは、C# でクラスやメソッドの概要、または引数の内容などを XML 形式で記述するコメントのことです。
参考 XML ドキュメント コメント (C# プログラミング ガイド)Microsoft ドキュメント
例として、ドキュメントコメントのタグには<summary>があります。
これはクラスやメソッドの説明に使用され、Visual Studio Code ではカーソルホバー時に summary の内容を表示してくれます。
コード内ハイパーリンクの作成方法
<see> タグと cref 属性を使って C# コード内にアクセス可能なハイパーリンクを作成します。
以下のコードでは SampleClassA クラスの Hoge()のドキュメントコメントに <see cref="SampleClassB.Fuga">と記載しています。
これでSampleClassB クラスの Fuga() へリンクを作成できます。
public class SampleClassA
{
/// <summary>
/// <see cref="SampleClassB.Fuga">
/// </summary>
void Hoge()
{
// 処理
}
}
public class SampleClassB
{
void Fuga()
{
// 処理
}
}see cref で作成したリンクからメソッド定義へ飛ぶことができます。以下の gif では see crefに記載したリンクから SampleClassBクラスの Fuga() へ移動しています。
また、メソッドを参照検索した際にも see cref で記載したクラスやメソッドが参照結果一覧に表示されます。
複数人でのゲーム開発時に、自分の書いたコードで他の人に留意してほしい事があれば<see> タグを活用して伝えることもできるかと思います。
参考資料
参考 <see> (C# プログラミング ガイド)Microsoft ドキュメント
関連記事
