ぶろぐめんどくさい

技術系の記事と漫画レビューが入り混じった混沌

Visual Studio CodeでXMLドキュメントのコメントを効率化する

VS Codeには、///と打つだけで<summary>などのコメントを補完してくれる「C# XML Documentation Comments」という拡張機能があります。 拡張機能のインストール方法は以下のページに記載されています。(英文注意)

marketplace.visualstudio.com

インストール方法のみを抜粋して説明します。

  1. Visual Studio Codeのバージョン1.22.0以上をインストール
  2. Visual Studio Codeを起動
  3. Ctrl-Shift-X (Windows, Linux)かCmd-Shift-X (macOS)で拡張機能ビューを開く
  4. C# XML Documentation Comments”を検索してインストール
  5. Visual Studio Codeを再起動

4.の行程が終わると画像のような表示になるはずです。

f:id:be116:20180511105508p:plain

Visual Studio Codeを再起動して、拡張機能が有効になっているか確認します。

f:id:be116:20180511111032g:plain

うまく働いてくれているようです。