ドキュメントコメントで C# コード内へのハイパーリンクを作成する

はじめに

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 ドキュメント

あわせて読みたい

2020年12月16日Unity 開発における C# のパフォーマンス最適化のTips

2020年12月11日【Unity】新規スクリプト生成時のテンプレートをカスタマイズしたい

Unityの教科書 Unity 2021完全対応版　2D＆3Dスマートフォンゲーム入門講座

北村愛実 (著)

いちばん売れているUnity入門書が最新バージョンに対応最新環境でゲーム制作を楽しく体験しましょう！
■本書の特徴 ●初めてゲーム制作にチャレンジする人に最適！
最初は簡単な2Dゲームの制作からスタートし、徐々に難しいゲームへと進めていきます。サンプルゲームの制作を通じて、Unityの機能と、ゲームを作るための知識が自然と身に付きます。

クリックして Amazon でチェック

Unityゲームプログラミング・バイブル 2nd Generation

森哲哉(著), 布留川英一(著), 他

Unityのゲーム開発現場で最も使われた決定版書籍が、大幅バージョンアップして登場！
ゲームの開発現場で即実践できるスキルが身につく！
本書は、ゲーム開発で最も使われている「Unity」の入門や初級レベルを卒業した方向けの書籍です。ゲームの開発現場で、即実践できるスキルが身につくように、「37」の最新のトピックを網羅しました。

クリックして Amazon でチェック

Unity ゲームエフェクトマスターガイド

秋山高廣 (著)

本書は，Unity上でゲームエフェクトを制作していく過程を解説した書籍です。Shader Graphを使用してシェーダーを作成し，Shurikenでエフェクト制作する過程を解説していきます。またHoudiniなどのDCC(Digital Content Creation)ツールを使ったリソース制作の方法についても解説しています。
Shurikenだけに的を絞った本ではなく，エフェクトに必要なシェーダー制作，リソース制作などにも踏み込んで解説しており，内容とレベルで妥協はありません。ゲームエフェクトの制作現場における必携の1冊です。

クリックして Amazon でチェック