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

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

速攻でメモできる QuickNote リリースしました!

QuickNoteは動作が超軽量でサクサクかけるノートアプリです。一瞬の閃きを逃さずにノートを開き書き始めることができます。 アカウント登録も不要です。お試しあれ!

Excel操作をコマンドで! proBoarderExcel

Excelはマウスで操作するのが基本ですが、マウス操作に疲れてはいませんか? キーボードでExcel操作ができるようになるアプリです。オープンソースで無料です。

積み上げ! Daily Stack リリースしました!

Daily Stack は日々の積み上げを管理するToDoアプリです。過去の積み上げの振り返りだけでなく、ツイート機能もあります。 アカウント登録不要ですぐに使い始めることができます。

ExecNote.app リリースしました!

ExecNoteは、コードが実行できるMarkdownアプリケーションです。Markdownドキュメント内に記載したコードをクリックすると実行ができます。わざわざターミナルを 起動させる必要がありません!無料ですのでもしよければダウンロードをお願いします。

About Me

11年目のシステムエンジニアです。アプリで生活や仕事を改善したい🐱仕事効率化、自動化のアプリ開発が得意です、ご相談ください。 🚀エンタメ系アプリの開発も模索中🐬社内SEや個人アプリ開発者、システムエンジニアになりたい人と繋がりたい🐱