转自:http://blog.sina.com.cn/s/blog_4080505a0101guoh.html
在使用Eclipse 编写Java代码时,自动生成的注释信息都是按照预先设置好的格式生成的。
修改作者、日期注释格式:打开Windows->Preferences->Java->Code Style->Code Templates,点击右边窗口中的Comments,可以看到有很多选项,我们便可对此注释信息模板进行编辑。
如我们希望在一个Java文件的开头设置作者信息、日期信息。
选择Types,点击Edit,将
/**
* @author ${user}
* ${tags}
*/
将${user}删除,改成你希望显示的名字;将${tags}删除,点击Insert Variable,选择Date,这样就会自动生成日期信息。在你需要添加注释的地方点击Sources->Ganarate Element Comment,或者使用快捷键 Alt+Shift+J ,则 eclipse 自动在该类前面添加注释。
注释的规范如下:
文件注释标签:
/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2007</p>
* <p>Company: LTGames</p>
* @author linrz
* @date ${date}
* @version 1.0
*/
类型注释标签(类的注释):
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* <p>Company: LTGames</p>
* @author linrz
* @date ${date}
*/
字段注释标签:
/** ${field}*/
构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法标签:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/
覆盖方法标签:
/* (非 Javadoc)
* <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}
*/
环境说明:
WindowsXP sp3
Eclipse3.6 Helios Release
一、.java 文件部分
---------------------
eclipse-->windows-->preferences-->Java-->Code Style-->Code Templates-->Code-->New Java files-->单击[edit]按钮
在文件首行,添加如下内容:
Java代码
${filecomment}
${package_declaration}
/**
* 创建时间:${date} ${time}
* 项目名称:${project_name}
* @author daniel
* @version 1.0
* @since JDK 1.6.0_21
* 文件名称:${file_name}
* 类说明:
*/
${typecomment}
${type_declaration}
${filecomment}
${package_declaration}
/**
* 创建时间:${date} ${time}
* 项目名称:${project_name}
* @author daniel
* @version 1.0
* @since JDK 1.6.0_21
* 文件名称:${file_name}
* 类说明:
*/
${typecomment}
${type_declaration}
或者
Java代码
${filecomment}
${package_declaration}
/**
* Filename: ${file_name}
* Copyright: Copyright (c)2010
* Company: com
* @version: 1.0
* @since: JDK 1.6.0_21
* Create at: ${date} ${time}
* Description:
*
* Modification History:
* Date Author Version Description
* -----------------------------------------------------------------
* ${date} daniel 1.0 1.0 Version
*/
${typecomment}
${type_declaration}
${filecomment}
${package_declaration}
/**
* Filename: ${file_name}
* Copyright: Copyright (c)2010
* Company: com
* @version: 1.0
* @since: JDK 1.6.0_21
* Create at: ${date} ${time}
* Description:
*
* Modification History:
* Date Author Version Description
* ------------------------------------------------------------------
* ${date} daniel 1.0 1.0 Version
*/
${typecomment}
${type_declaration}
二、.jsp 文件部分
---------------------
eclipse-->windows-->preferences-->Web-->JSP Files-->Editer-->Templates-->New JSP File-->单击[edit]按钮
在文件首行,添加如下内容:
Java代码
<%--
创建时间:${date}${time}
创 建 人:daniel
相关说明:
JDK1.6.0_21 tomcat6.0.29 servlet2.5
--%>
<%--
创建时间:${date}${time}
创 建 人:daniel
相关说明:
JDK1.6.0_21 tomcat6.0.29 servlet2.5
--%>
这样再创建 .java 或 .jsp 文件时,eclipse 就会为我们自动将注释写好。你还可以通过“导出”、“导入”功能,把自己的模板导出来,方便在其他机器上使用。
相关推荐
在Eclipse这一强大的集成开发环境(IDE)中,设置自动生成注释的功能是提升编码效率、维护代码可读性及专业性的有效手段。对于初学者乃至资深开发者而言,掌握如何在创建新类时自动添加注释,不仅能节省时间,还能...
注释模板是预定义的一段代码,包含了经常需要在注释中出现的结构和内容,例如作者、日期、版权信息等。在Eclipse中,我们可以为不同的语言(如Java、XML)以及不同的注释类型(如类、方法、变量)创建不同的模板。 ...
在新建Java文件时,通过配置好的模板自动生成文件头部注释,包含作者信息、创建日期等内容。 **2. 类级注释** 除了文件头部注释外,还可以针对每个类自动生成注释信息,便于其他开发者了解该类的功能和用途。 **3...
2. **模板定制**:JAutodoc允许用户自定义注释模板,可以根据个人或团队的编码规范来设置注释格式,例如添加作者、日期、版权信息等。 3. **多语言支持**:除了Java,JAutodoc还支持其他编程语言,如C++、C#等,使...
这些模板包含了如作者、创建日期、版权信息等常见元素,当需要为代码添加注释时,只需通过快捷键或者右键菜单选择相应选项,就可以快速生成结构化的注释。例如,对于一个类的注释,可能包括了类的描述、作者、版本...
1. **类注释**:当创建一个新的类时,Eclipse可以根据预设的模板自动添加注释,包含类的用途、作者、日期以及版权信息等。 2. **方法注释**:为每个方法生成注释,可能包括方法的功能描述、参数解释、返回值和异常...
Eclipse的注释模板允许你定义预设的注释结构,当编写代码时,只需快捷键或通过菜单选择,就能自动生成注释。这包括类、方法、变量等不同级别的注释。比如,你可以定义一个类注释模板,包含版权信息、作者、创建日期...
对于重写的方法,Eclipse还支持自动生成特殊的注释模板,以突出显示重写了哪个父类的方法: 1. **选择Overriding Methods**。 2. **编辑重写方法注释模板**: ``` /* (Javadoc) * <p>Title: ${enclosing_method}...
Eclipse提供了便捷的自动注释功能。在编写代码时,可以使用快捷键(如Ctrl+Shift+J)插入单行注释,或者在方法、类等上面使用Alt+Shift+J插入Javadoc。通过设置,可以调整这些快捷键,以符合个人习惯。 六、代码...
其中,Eclipse的代码模板(Code Templates)功能是程序员们常用的工具,能够帮助自动生成类、方法以及各种注释,从而节省手动编写的时间。本篇文章将详细探讨如何在Eclipse中设置和使用自动类方法的注释。 Eclipse...
完成以上配置后,在新建或编辑 Java 文件时,Eclipse 将会根据设置好的模板自动生成相应的文档注释。这不仅大大减轻了编写文档注释的工作量,而且还能确保所有文档注释的一致性和规范性,提高代码的整体质量。 ####...
这样,当你为类、方法或字段添加Javadoc时,Eclipse会根据模板自动生成注释结构。 6. **设置用户变量**:在每个模板中,你可以使用预先定义的变量,如`${user}`代表当前登录的Eclipse用户的名称,`${date}`代表当前...
在Eclipse中,可以通过`Import`功能导入已经配置好的注释模板设置。这使得开发者可以轻松地将一套成熟的注释模板应用到自己的环境中,无需从头开始设置。 6. **使用步骤**: - 打开Eclipse并进入`Preferences`。 ...
5. **注释生成**:MBG支持自定义生成的代码中的注释,如作者、日期等信息,有助于代码管理和团队协作。 6. **自定义模板**:用户可以根据自己的需求定制生成代码的模板,使生成的代码更符合项目的规范。 **四、...
注释模板是Eclipse为开发者提供的一种自动生成注释的功能,通过预设的模板格式,可以在创建新的类、方法、字段或构造函数时自动插入相应的注释框架,从而大大节省了手动输入的时间,提高了开发效率。同时,统一的...
Java注释模板主要用于快速生成标准的代码注释,如作者信息、创建日期、修改历史等。这对于团队协作和代码审查非常有用,同时也方便日后的维护工作。 三、设置Java注释模板步骤 1. 打开Eclipse或MyEclipse,进入...
关闭首选项对话框后,创建一个新的Java类,你会发现注释已经按照你刚才设置的模板自动生成了。 此外,Eclipse还允许为接口、枚举等其他类型设置不同的注释模板,只需在代码模板的相应类别下进行类似的操作即可。...
- 类注释(Types):适用于类或接口的注释,通常包含版权信息、作者、日期等。 - 方法注释(Methods):为每个方法生成注释,可以包含参数、返回值、异常等信息。 - 字段注释(Fields):针对类中的变量添加注释...
- 这个模板包含了日期、时间、作者、参数和返回值描述等常见注释元素,你可以根据实际需求进行修改。 - 完成后点击“OK”保存设置。 2. **使用注释模板** - 创建或打开一个Java文件,将光标置于需要添加注释的...