您的位置:首页 > 编程语言 > Java开发

Eclipse自动生成作者、日期注释等功能设置

2015-10-11 14:33 316 查看
在使用Eclipse 编写Java代码时,自动生成的注释信息都是按照预先设置好的格式生成的。

修改作者、日期注释格式:打开Windows->Preferences->Java->Code Style->Code Templates,点击右边窗口中的Comments,可以看到有很多选项,我们便可对此注释信息模板进行编辑。

如我们希望在一个Java文件的开头设置作者信息、日期信息。

选择Types,点击Edit,将

/**

* @author user∗{user}
* {tags}

*/

将user删除,改成你希望显示的名字;将{user}删除,改成你希望显示的名字;将{tags}删除,点击Insert Variable,选择Date,这样就会自动生成日期信息。在你需要添加注释的地方点击Sources->Ganarate Element Comment,或者使用快捷键 Alt+Shift+J ,则 eclipse 自动在该类前面添加注释。

注释的规范如下:

文件注释标签:

/**

*
Title: ${file_name}</p>

*
Description: </p>

*
Copyright: Copyright (c) 2007</p>

*
Company: LTGames</p>

* @author linrz

* @date ${date}

* @version 1.0

*/

类型注释标签(类的注释):

/**

*
Title: ${type_name}</p>

*
Description: </p>

*
Company: LTGames</p>

* @author linrz

* @date ${date}

*/

字段注释标签:

/* ${field}/

构造函数标签:

/**

*
Title: </p>

*
Description: </p>

* ${tags}

*/

方法标签:

/**

*
Title: ${enclosing_method}</p>

*
Description: </p>

* ${tags}

*/

覆盖方法标签:

/* (非 Javadoc)

*
Title: ${enclosing_method}</p>

*
Description: </p>

* tags∗{tags}
* {see_to_overridden}

*/

代表方法标签:

/**

* tags∗{tags}
* {see_to_target}

*/

getter方法标签:

/**

* @return barefieldname∗/setter方法标签:/∗∗∗@param{bare_field_name}
*/
setter方法标签:
/**
* @param {param} 要设置的 ${bare_field_name}

*/

环境说明:

WindowsXP sp3

Eclipse3.6 Helios Release

一、.java 文件部分

eclipse–>windows–>preferences–>Java–>Code Style–>Code Templates–>Code–>New Java files–>单击[edit]按钮

在文件首行,添加如下内容:

Java代码

filecomment{filecomment}
{package_declaration}

/**

* 创建时间:date{date} {time}

* 项目名称:projectname∗@authordaniel∗@version1.0∗@sinceJDK1.6.021∗文件名称:{project_name}
* @author daniel
* @version 1.0
* @since JDK 1.6.0_21
* 文件名称:{file_name}

* 类说明:

*/

typecomment{typecomment}
{type_declaration}

filecomment{filecomment}
{package_declaration}

/**

* 创建时间:date{date} {time}

* 项目名称:projectname∗@authordaniel∗@version1.0∗@sinceJDK1.6.021∗文件名称:{project_name}
* @author daniel
* @version 1.0
* @since JDK 1.6.0_21
* 文件名称:{file_name}

* 类说明:

*/

typecomment{typecomment}
{type_declaration}

或者

Java代码

filecomment{filecomment}
{package_declaration}

/**

* Filename: filename∗Copyright:Copyright(c)2010∗Company:com∗@version:1.0∗@since:JDK1.6.021∗Createat:{file_name}
* Copyright: Copyright (c)2010
* Company: com
* @version: 1.0
* @since: JDK 1.6.0_21
* Create at: {date} time∗Description:∗∗ModificationHistory:∗DateAuthorVersionDescription∗—————————————————————–∗{time}
* Description:
*
* Modification History:
* Date Author Version Description
* —————————————————————–
* {date} daniel 1.0 1.0 Version

*/

typecomment{typecomment}
{type_declaration}

filecomment{filecomment}
{package_declaration}

/**

* Filename: filename∗Copyright:Copyright(c)2010∗Company:com∗@version:1.0∗@since:JDK1.6.021∗Createat:{file_name}
* Copyright: Copyright (c)2010
* Company: com
* @version: 1.0
* @since: JDK 1.6.0_21
* Create at: {date} time∗Description:∗∗ModificationHistory:∗DateAuthorVersionDescription∗——————————————————————∗{time}
* Description:
*
* Modification History:
* Date Author Version Description
* ——————————————————————
* {date} daniel 1.0 1.0 Version

*/

typecomment{typecomment}
{type_declaration}

二、.jsp 文件部分

eclipse–>windows–>preferences–>Web–>JSP Files–>Editer–>Templates–>New JSP File–>单击[edit]按钮

在文件首行,添加如下内容:

Java代码

<%–

创建时间:date{date}{time}

创 建 人:daniel

相关说明:

JDK1.6.0_21 tomcat6.0.29 servlet2.5

–%>

<%–

创建时间:date{date}{time}

创 建 人:daniel

相关说明:

JDK1.6.0_21 tomcat6.0.29 servlet2.5

–%>

这样再创建 .java 或 .jsp 文件时,eclipse 就会为我们自动将注释写好。你还可以通过“导出”、“导入”功能,把自己的模板导出来,方便在其他机器上使用。
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: