l08084のブログ

技術記事の執筆は、祈りに近い

VSCodeでJavaScriptのドキュメンテーションコメント(JSDoc)を自動生成する

f:id:l08084:20180208152959p:plain

はじめに

Visual Studio Codeを使用してJSDocコメントを自動生成する方法について書きます。

JSDoc自動生成方法

Document Thisのインストール

VSCode拡張機能ボタンをクリックした後、Document Thisをインストールする。 なお、Document ThisはJavaScriptだけでなく、TypeScriptにも対応している。 f:id:l08084:20180208151738p:plain

JSDocコメント生成

インストールが完了したら、JSDocコメントを作成したい関数にカーソルを合わせて、Ctrl+Alt+Dを2回実行するとコメントを生成してくれる(Mac book proとかだとAltキーはないのでOptionキーになる)。 f:id:l08084:20180208152222p:plain