写了一Vim的注释插件,支持PHP/JS/JAVA/C#/PYTHON

7409 次阅读 by 九九 2012-05-17 | 标签:vim 玩具 总结

之前一直想能不能弄到一个自动添加注释的vim插件,像之前用phpdesinger它里面可以配置快捷键,来对应代码模板,通过这个设置可以做到自己的代码注释。不过它不能自动的检测当前函数里的变量参数等。之前一段时间也在网上找了好多的相关插件像javacommenter.vim等,但还是不能达到我想要的效果。于是,哈哈,自己动手码了一个,自己用了有一段时间了,感觉还不错,特点:
1. 可以按当前文件的后缀来自动判断当前使用的注释类型,如*.java/*.php/*.cs用“*”、“//”来注释,而对于*.py/*.vim则用“"”、“'”来注释。
2. 对于方法注释可以自动完成对当前方法变量参数的注释(还不支持换行的参数自动注释 :D);
3. 可以通过配置来设置当前的svn版本号是来自手动设,还是通过“$Id$”来生成;
4. 用户可以自己配置更多的注释变量。
Ok,接下来看几个实例。
1. 对文件的注释:
快捷键:ctrl + f
操作:在需要添加文件注释的地方输入“//f”,然后按快捷键“ctrl+f”即可。
示例:

//f
得到:
//单引号类型的注释,如python
""" 
" @version	 $Id: test-codecommenter.vim 74 2012-02-17 01:45:19Z xjiujiu@gmail.com $ 
" @package None 
" @subpackage None 
" @copyRight Copyright (c) 2011-2012 http://www.xjiujiu.com.All right reserved 
" 
""" 
//* 类型的注释,如java/php/C#
/** 
* @version	 $Id: test-codecommenter.vim 74 2012-02-17 01:45:19Z xjiujiu@gmail.com $ 
* @package: None 
* @subpackage: None 
* @copyRight: Copyright (c) 2011-2012 http://www.xjiujiu.com.All right reserved 
* @license: Apache GNU 
* 
*/
2. 对类的注释:
快捷键:
ctrl+v
操作:在需要添加变量注释的地方输入“//c”然后,按快捷键“ctrl+v”即可。
示例:

//c
class ExampleClass 
{
    //some code
}

得到:br/>

/** 
* @point 
* 
* @desc 
* 
* @author 九九* @package None 
* @version	 $Id: test-codecommenter.vim 74 2012-02-17 01:45:19Z xjiujiu@gmail.com $ 
*/ 
class ExampleClass 
{
    //some code
}

3. 方法注释
快捷键:ctrl+m
操作:在需要添加方法注释的地方输入“//m”然后,按快捷键“ctrl+m”即可。
示例:

//m
function GetName(string test, int yes) 
endfunction

得到:

//vim 注释
""" 
" @point 
" 
" @desc 
" 
" @access public 
" @param string test 
" @param  int yes 
" @return void 
" @exception none 
""" 
function GetName(string test, int yes) 
endfunction

4. 变量的注释
快捷键:ctrl + v
操作:在需要添加方法注释的地方输入“//v然后,按快捷键“ctrl+v”即可。
示例:

//v
$string     = "test"

得到:

/** 
* var $string     
*/ 
$string     = "test"

如果你觉得OK,下载地址:codecommenter.vim
如果你感兴趣,灰常欢迎前来一起完善它,svn 地址为:https://xjiujiu-open-work.googlecode.com/svn/tags/CodeCommenter1.0.0


评论(8)

Satchell To 九九 (2017-06-14)

It's great to find an expert who can exalipn things so well

PS:多打字可以减肥哦~234字以内。支持表情:


Top