Eclipse注释模板,在这里整理了一下自己在用的一套。
- 设置注释模板的步骤:点击菜单栏上的Window -->Preferences–>Java–>Code Style -->Code Templates,对右侧Comments选项中具体的注释信息进行编辑即可。可勾选上自动添加注释信息,在生成java文件时便会自动生成注释,当然也可以手动插入注释,如图:
2.点击Edit按钮,进入编辑页面,全部编辑完成后点击“Apply And Close”即可设置完成,并关闭设置页面。
3.下面介绍具体的Comment如何设置:
3.1文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author: King(作者)
* @date: ${date} ${time}
* @version V1.0
* @Copyright: ${year} Inc. All rights reserved.
*/
3.2类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: (描述)
* @author : king(作者)
* @date ${date} ${time}
* ${tags}
*/
3.3字段(Fields)注释标签:
/**
* @Fields ${field} :
*/
3.4构造函数标签:
/**
* @Title: ${enclosing_type}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param: ${tags}
* @throws
*/
3.5方法(Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description : (描述)
* @author : King
* @date ${date} ${time}
* ${tags}
*/
3.6 覆盖方法(Overriding Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description:
* @author whd
* @date ${date} ${time}
* ${tags}
*/
3.7 代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
3.8 getter方法标签:
/**
* @Title: ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/
3.9 settter方法标签:
/**
* @Title: ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/