jcommenter.vim : JavaDocコメントを生成
指定した変数、メソッドのJavaDocコメントの雛形を生成するスクリプトです。 (Windows, Mac)
概要
jcommenter.vim : A script for automatically generating JavaDoc comments
http://www.vim.org/script.php?script_id=20
JavaDoc用のコメントの雛型を書きこんでくれるスクリプトです。

上の、このJavaソースに対して、スクリプトを使用すると

この様なJavaDocコメントの雛型を作り出します。
インストール方法
$VIMRUNTIME/macrosにjcommenter.vimスクリプトをコピーしてください。
ファイル | URL |
---|---|
jcommenter.vim | http://www.vim.org/script.php?script_id=20 |
次に_vimrc設定ファイルに次の設定を追加します。
:autocmd FileType java source $VIMRUNTIME/macros/jcommenter.vim :autocmd FileType java map <C-c> :call JCommentWriter()<CR>
jcommenter.vimをテキストエディタで開き、 80~100行目の範囲にある(version 1.2.1)
:let b:jcommenter_class_author = "" :let b:jcommenter_class_version = "" :let b:jcommenter_file_author = "" :let b:jcommenter_file_copyright = ""
を、例えば下記のように書きかえてください。
:let b:jcommenter_class_author = "作者名" :let b:jcommenter_class_version = "$Revision: 1.6 $" :let b:jcommenter_file_author = "作者名" :let b:jcommenter_file_copyright = "作者名"
使用方法
下記のような個所と同じ行で Ctrl-c と入力すると、 コメントが挿入されます。
public class Main {
public String toString(){
public void setString(String str){
上のソースが、下のようになります。↓
/** * * * @author 作者名 * @version $Revision: 1.6 $ */ public class Main {
/** * * * @return */ public String toString(){
/** * * * @param str */ public void setString(String str){
また、ソースの一行目(最上段)で Ctrl-c を押すと、 下のようなコメントを生成します。
/* file name : c:/usr/root/tmp/tmp.java * authors : 作者名 * created : 02/08/12 0:19:18 * copyright : 作者名 * * modifications: * */
さらに、ブレースの対応コメントも挿入できます。
下のソースの3行目で Ctrl-c を押すと、
public void do(){
somemethod();
}
次のようなコメントを生成します。
public void do(){
somemethod();
} // END: do
Recent Comments
ありがとうございます!
http://nanasi.jp/articles/howto/editing/visualcursor-endtoend.html · 7 years ago
知りませんでした。有難うございました。
http://nanasi.jp/articles/howto/file/open-with-format.html · 9 years ago
<c-f>1ページ分、下にスクロールする<c-b>1ページ分、上にスクロールする
どっちも逆です。
http://nanasi.jp/articles/howto/user-manual/user-manual-motion.html · 10 years ago
set 使用時に : で閉じるのを忘れて右往左往してました。
http://nanasi.jp/articles/howto/file/modeline.html · 11 years ago
やっぱり日本語の方が早いっす。
http://nanasi.jp/articles/howto/help/help_ja.html · 12 years ago