読者です 読者をやめる 読者になる 読者になる

JSDoc 形式のコメントを追記する Vim スクリプトを書きました

JavaScript の関数に JSDoc 形式のコメントを追加する Vim スクリプトを書きました。

tanabe/WriteJSDocComment.vim - GitHub

実行例

JavaScript の function が書かれている行にカーソルがある状態で :call WriteJSDocComment() を実行すると下記スクリーンショットのように JSDoc 形式のコメントブロックが挿入されます。

対応しているタグ (ver 0.2)

  • @name
  • @function
  • @param
  • @return

インストールの前に

WriteJSDocComment.vimPerl で書かれているため、Vim が +perl オプション付きでコンパイルされている必要があります。VimPerl インタフェースに対応しているか確認するには、下記のコマンドを実行します。1 が表示されれば Perl インタフェースに対応しています。

:echo has('perl')

0 が返ってきた場合は、Vim を +perl オプション付きで再コンパイルしてください。

#ソースからの場合 (例)
$ ./configure --enable-perlinterp --enable-multibyte --with-features=huge

#MacPorts の場合 (例)
$ sudo port install vim +perl +multibyte +huge 

インストール

  1. GitHub のリポジトリから WriteJSDocComment.vim をダウンロードします。
  2. ~/.vim/ftplugin/javascript/ に WriteJSDocComment.vim をコピーします。
  3. 適当なキーに WriteJSDocComment() をマッピングします。

私は C-c で関数を実行するようにしました。.vimrc に下記を追記しています。

au FileType javascript nnoremap <buffer> <C-c> :<C-u>call WriteJSDocComment()<CR>