`

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

 
阅读更多

转自: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 就会为我们自动将注释写好。你还可以通过“导出”、“导入”功能,把自己的模板导出来,方便在其他机器上使用。

分享到:
评论

相关推荐

    AndroidBase android 应用开发框架.zip

    文档生成工具可以自动生成代码注释文档,便于团队内外理解和使用项目代码。 API管理工具则方便开发者创建、测试、发布和维护API接口。 持续集成与持续部署(CI/CD): Jenkins、Travis CI、GitHub Actions等...

    java源码包2

     util实现Java图片水印添加功能,有添加图片水印和文字水印,可以设置水印位置,透明度、设置对线段锯齿状边缘处理、水印图片的路径,水印一般格式是gif,png,这种图片可以设置透明度、水印旋转等,可以参考代码...

    java源码包---java 源码 大量 实例

     util实现Java图片水印添加功能,有添加图片水印和文字水印,可以设置水印位置,透明度、设置对线段锯齿状边缘处理、水印图片的路径,水印一般格式是gif,png,这种图片可以设置透明度、水印旋转等,可以参考代码...

    JAVA上百实例源码以及开源项目

     util实现Java图片水印添加功能,有添加图片水印和文字水印,可以设置水印位置,透明度、设置对线段锯齿状边缘处理、水印图片的路径,水印一般格式是gif,png,这种图片可以设置透明度、水印旋转等,可以参考代码...

    JAVA上百实例源码以及开源项目源代码

     util实现Java图片水印添加功能,有添加图片水印和文字水印,可以设置水印位置,透明度、设置对线段锯齿状边缘处理、水印图片的路径,水印一般格式是gif,png,这种图片可以设置透明度、水印旋转等,可以参考代码...

    java源码包3

     util实现Java图片水印添加功能,有添加图片水印和文字水印,可以设置水印位置,透明度、设置对线段锯齿状边缘处理、水印图片的路径,水印一般格式是gif,png,这种图片可以设置透明度、水印旋转等,可以参考代码...

    java源码包4

     util实现Java图片水印添加功能,有添加图片水印和文字水印,可以设置水印位置,透明度、设置对线段锯齿状边缘处理、水印图片的路径,水印一般格式是gif,png,这种图片可以设置透明度、水印旋转等,可以参考代码...

    成百上千个Java 源码DEMO 4(1-4是独立压缩包)

    图片水印 util实现Java图片水印添加功能,有添加图片水印和文字水印,可以设置水印位置,透明度、设置对线段锯齿状边缘处理、水印图片的路径,水印一般格式是gif,png,这种图片可以设置透明度、水印旋转等,可以参考...

    成百上千个Java 源码DEMO 3(1-4是独立压缩包)

    图片水印 util实现Java图片水印添加功能,有添加图片水印和文字水印,可以设置水印位置,透明度、设置对线段锯齿状边缘处理、水印图片的路径,水印一般格式是gif,png,这种图片可以设置透明度、水印旋转等,可以参考...

    Java开发实战1200例(第1卷).(清华出版.李钟尉.陈丹丹).part3

    实例012 设置Eclipse中文API提示信息 18 实例013 为项目添加类库 20 实例014 使当前项目依赖另一个项目 21 1.3 界面设计器 22 实例015 安装界面设计器 22 实例016 设计Windows系统的运行对话框 界面 23 实例017 设计...

    php网络开发完全手册

    10.2.4 异常处理函数设置set_exception 10.2.4 _handler 157 10.2.5 完整的异常信息 158 10.3 扩展的异常处理类 160 10.4 异常的传递与重掷 163 10.5 小结 165 第11章 PHP与表单 166 11.1 HTML表单简介 166 11.1.1 ...

    freemarker语法完整版

    sequence 序列,对应java 里的list 、数组等非键值对的集合 hash 键值对的集合 namespace 对一个ftl 文件的引用, 利用这个名字可以访问到该ftl 文件的资源 B 指令 if, else, elseif 语法 Java代码 ...

    疯狂JAVA讲义

    学生提问:图11.15和图11.16显示的所有按钮都紧挨在一起,如果希望像FlowLayout、GridLayout等布局管理器指定组件的间距该怎么办? 397 11.4 AWT 常用组件 398 11.4.1 基本组件 398 11.4.2 对话框 400 11.5 事件...

Global site tag (gtag.js) - Google Analytics