具体参数设置请参考文章:http://blog.csdn.net/shiyuezhong/article/details/8450578
(1)在方法或者属性上面添加注释:
在方法或者属性字段的上面一行输/**,然后回车。一般情况下添加的注释格式如下所示,当然注释的格式是可以修改的:
1 2 3 4 5 |
/** * @param * @return * @throws Exception */ |
(2)在文件头添加注释:
用快捷键Alt+Shift+J可以为文件头快速添加注释。
(3)修改注释的格式:
添加的注释格式是可以修改的,通过菜单Window->Preference打开参数设置面板,然后选择:Java -> Code Style -> Code Templates,在右侧选择Comments就可以修改注释的格式。如下图所示:
(4)添加注释的种类:
从上图可以看到添加注释的有Files(文件)注释,Types(类)注释,Fields(属性)注释等。
(5)导出和导入注释:
通过导出和导入功能,可以把自己的模板导出来在其他机器上使用
(6)注释变量的设置
我们在写代码注释时经常会出现author,这个author默认的$(user)名也是Administrator。
如果要修改这个名的话,可以这样做,打开eclipse安装目录下的eclipse.ini文件,在文件的末尾添加:
-Duser.name=your name
然后重启eclipse就行了。
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。
文件(Files)注释标签:
1 2 3 4 5 6 7 8 |
/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author ${user} * @date ${date} * @version V1.0 */ |
类型(Types)注释标签(类的注释):
1 2 3 4 5 6 7 8 |
/** * @ClassName: ${type_name} * @Description: ${todo}(这里用一句话描述这个类的作用) * @author ${user} |