「jsdoc.vim」の版間の差分

2014年9月7日 (日) 23:08時点における最新版

jsdoc.vimとは、JSDocのブロックコメントジェネレータです。vimのドキュメント入力補完機能として使えます。

読み方

jsdoc.vimでは、vimでJavaScriptプログラミングをしているときに、JSDoc形式のコメントの入力補完ができます。

vimの設定ファイル .vimrc を設定します。以下は、NeoBundle用の設定です。

NeoBundle 'heavenshell/vim-jsdoc'

デフォルトのキーマッピングがC-l(C-L)という(困る方には)困ったマッピングです。

以下の設定をすることで、C-l以外のマッピングを自分で設定できます。

let g:jsdoc_default_mapping = 0
nnoremap <silent> <C-J> :JsDoc<CR>

コメントを入力したい関数定義の直前などで C-l (コントロールエル)を押すとコメントが自動的に挿入されます。

例えば、今、カーソルが１８行目にあるとします。

 18
 19 function square(a) {
 20         return a*a;
 21 }

ここで、C-l を押します。

このように展開されます。

 18 /**
 19  *
 20  *
 21  * @return {undefined}
 22  */
 23
 24 function square(a) {
 25         return a*a;
 26 }

@@ 行8: / 行8: @@
 [[jsdoc.vim]]では、vimでJavaScriptプログラミングをしているときに、[[JSDoc]]形式のコメントの入力補完ができます。
 == .vimrc ==
+vimの設定ファイル .vimrc を設定します。以下は、NeoBundle用の設定です。
 <syntaxhighlight lang="vim">
 NeoBundle 'heavenshell/vim-jsdoc'
+</syntaxhighlight>
+=== デフォルトのキーマッピングを変更する ===
+デフォルトのキーマッピングがC-l(C-L)という(困る方には)困ったマッピングです。
+以下の設定をすることで、C-l以外のマッピングを自分で設定できます。
+<syntaxhighlight lang="vim">
+let g:jsdoc_default_mapping = 0
+nnoremap <silent> <C-J> :JsDoc<CR>
 </syntaxhighlight>
 == 使い方 ==