VSCode c#のコメントを簡単に記述する拡張機能

Visual Studio Codeではc#プログラミングもできますが、Visual Studioほど十分な機能を備えていません。

不足している機能は様々ありますが、そのうちの1つとして、XMLドキュメント形式のコメント記述が自動補完されない、というものがあります。

ただしこれは拡張機能をインストールすることでカバー可能ですので、紹介します。

1. インストール方法

以下の「c# XML Documentation Comments」という拡張機能をインストールします。

2. コメントの記述方法

コメントの記述方法は簡単で、メソッドなど記述したい箇所の上の行で「///(スラッシュ3つ)」を入力します。

すると自動的に保管されます。

引数や返り値のあるメソッドもちゃんと認識して保管してくれます。

3. c# ドキュメントコメントとして推奨されるxmlタグ

ドキュメントコメントとして使えるXMLタグは様々ありますが、代表的なものは以下です。

  • <summary>

型やメソッドなどの説明に使用します。

  • <returns>

返り値の説明に使用します。メソッドの宣言の先頭に記述するコメントで使用します。

  • <param>

メソッドのパラメタを記述するのに使用します。name属性でパラメタ名を記述します。

詳細は以下の公式ドキュメントを参照ください。

https://docs.microsoft.com/ja-jp/dotnet/csharp/language-reference/xmldoc/recommended-tags

Visual Studio Codeは機能ありすぎ!

Visual Studio Codeはオープンソースのコードエディタです。

コードエディタと言いつつも、デバッグもできますし簡易Webサーバも立てられますし、ソースコード中のTODOを検索してツリー表示することもできます。

インストール可能な拡張機能の数は30,000以上と言われており、とても便利な機能が数多くあります。

そのため、Visual Studio Codeを使いこなすには、それなりの情報収集が必要です。

「Visual Studio Code実践ガイド」は、

  • Visual Studio Codeの基本的な使い方
  • TypeScriptやPythonなど、実際の開発を通した Visual Studio Code機能の紹介
  • Visual Studio Code拡張機能の開発方法の紹介

などが収録されており、Visual Studio Codeの機能を体系的に理解するのに最適な書籍です。

電子書籍化されていますので、まずは kindleなどで試し読みしてみてはいかがでしょうか。

コメントを残す

メールアドレスが公開されることはありません。