在使用Eclipse编写Java代码时,可以自动生成预先设置好格式的注释信息。期中部分信息可以动态的生成。
依次点击Windows->Preferences->Java->Code Style->Code Templates
然后我们就可以选择右边窗口中的Comments,对应具体的comments选项,我们便可以对具体的注释信息进行编辑设置。
如我们希望在一个Java文件的开头设置作者信息以及日期信息。
选择Types,点击Edit,默认将显示如下信息:
/**
* @author ${user}
* ${tags}
*/
其中${user}默认会自动生成为操作系统当前登陆账户名,如果想要改成自己的名字,只要把这部分内容替换成自己的名字就可以了。点击Insert Variable,选择Date,这样就会自动生成日期信息。
下面介绍一下各个动态标签代表的意义
${date} 自然就是日期了 生成的格式为月、日、年,如:Jan 14, 2013
${package_name} 生成从根目录开始到当前目录的包名,用“.”分隔,如:com.xxx.testtest
${project_name} 生成当前工程的名字
${time} 生成当前的时间 ,格式如下:9:25:16
${year} 生成当前的年份 ,如2013
如在方法里面${tags}标签自动生成为参数的变量名
同样的步骤,我们也可以对其他例如构造函数等等注释信息进行编辑设置。
使用时鼠标放置在需要添加注释的方法内部的任意位置。点击菜单栏中source下的Generate Element Comment,或者使用快捷键Alt+Shift+J,则eclipse自动在该方法前面添加注释。
同时,为了方便移植,也可以点击import或者export导入或者导出xml文件。
注释的规范如下:
文件注释标签:
/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Company: </p>
* @author
* @date ${date}
* @version 1.0
*/
类型注释标签(类的注释):
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* <p>Company: </p>
* @author
* @date ${date}
*/
字段注释标签:
/** ${field}*/
构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法标签:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/
覆盖方法标签:
/*
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法标签:
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签:
/**
* @return ${bare_field_name}
*/
setter方法标签:
/**
* @param ${param} 要设置的 ${bare_field_name}
*/