目次
はじめに
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 ドキュメント
あわせて読みたい
【Unity】C#に関するパフォーマンス最適化のTips
【Unity】新規スクリプト生成時のテンプレートをカスタマイズしたい
Unityの教科書 Unity 2021完全対応版 2D＆3Dスマートフォンゲーム入門講座
いちばん売れているUnity入門書が最新バージョンに対応 最新環境でゲーム制作を楽しく体験しましょう！ ■本書の特徴 ●初めてゲーム制作にチャレンジする人に最適！ 最初は簡単な2Dゲームの制作からスタートし、徐々に難しいゲームへと進めていきます。サンプルゲームの制作を通じて、Unityの機能と、ゲームを作るための知識が自然と身に付きます。 ●プログラムの書き方がわからなくても大丈夫！ C＃の基礎知識も掲載しているので、プログラミング経験のまったくない人でも、安心して学習を開始することができます。 ●ゲームを面白くするためのヒントを掲載！ Unityの使い方だけでなく、ゲームの設計方法、レベルデザインなど、ゲームを面白く作るための知識も紹介しています。
作って学べる Unity 本格入門 ［Unity 2021対応版］ 作って学べる開発入門
本書はUnityでゲーム開発を行いたい人を対象に、1つのゲームを制作する流れを通してUnity 2021の操作が学べる入門解説本です。本書内で武器などを調達し、食べ物を求めながら冒険し、武器でモンスターと戦う3Dアクションゲームを制作していきます。本格的なゲームを実際に制作しながらUnityの使い方を学べますので、楽しみながら学びことができ、かつ実践的なテクニックも身につけることができます。
新・標準プログラマーズライブラリ なるほどなっとく C#入門
本書は、プログラミングの知識・経験がなくてもC#の基本文法を身につけることができる入門書です。 そのために、「初心者に理解して身につけてほしい機能を厳選し、ポイントを絞る」 「C#になぜその機能があるのか、どんな場面で使うのかという点も納得できる」という方針で解説しています。 C#の文法は膨大ですが、これから学ぼうとする方は、すべてを覚える必要はありません。 本書を通して、「なぜ」という疑問をひとつひとつ解消しながら、 利用頻度の高い文法をしっかりと自分のものにすることができます。
