徒然なるままにBlog

Javaでコードを書いてるとついて回るのがJavaDoc用のコメント書きだ。
複数人で開発するなら当然だが一人だけの場合でも以後のメンテナンス性を考えればコメントはあるに越したことはない。
だがクラスやメソッドを追加するたび、/**やら@versionやら@paramやらを書いていくのは冗長で正直面倒だ。
この場合開発環境にvimを使っていればjcommenterを使用すればこの煩わしさから解放される。
jcommenterとはJavaソース内のクラスやメソッドのコメント雛形を自動で生成してくれるvimスクリプトの一つだ。
使い方はまずjcommenterの公式サイトから落としてきたjcommenter.vimを$VIMRUNTIME/macrosに配置する。
その後~/.vimrcなどのvim設定ファイルに

autocmd FileType java source $VIMRUNTIME/macros/jcommenter.vim
autocmd FileType java map <C-c> :call JCommentWriter()<CR>

と書き加える。
上記設定が完了後、Javaソースファイルを開き

public class test

のようなクラス名記述の行に移動しCtrl-cを入力すると

/** 
 * 
 * 
 * @author 
 * @version 
 */
public class test

と自動でコメント入力のための雛形を生成してくれる。
@authorなどの後に続く名前などの情報はjcommenter.vim内の記述を変更することでデフォルト値を設定することが可能だ。
メソッドの場合も同じように

public String doSomething(String value)

のような部分でCtrl-cを入力すると

/** 
 * 
 * 
 * @param value
 
 * @return 
 */
public String doSomething(String value)

という形で雛形を生成してくれるのでパラメータが多い場合など非常に重宝する。
EclipseなどのIDEを使わずJDK+vimで開発する場合は割と必須なvimスクリプトだと思う。