Eclipse 自动生成注释信息

Eclipse 自动生成注释信息

一、概述

      程序中良好的文档注释不仅有利于程序的阅读而且还有利于日后程序开发人员对程序的升级和维护。

      我们可以利用 Eclipse 中注释的模版功能自动插入相关文档注释，从而进一步提升我们的工作效率。

二、编辑Eclipse注释模版

      在Eclipse中可以通过 windows → Preferences → Java → Code Style → Code Templates → Comments 展开编辑相关注释模版

      
      
      

      

      注：这里如果勾选了 Automatically add comments for new methods and types，应用后再创建 java 文件，系统会自动识别添加相应的注释

三、编辑文档注释模版

File节点（文件注释标签）

/**   

* @Title: ${file_name} 

* @Package ${package_name} 

* @Description: ${todo}(用一句话描述该文件做什么) 

* @author fsjohnhuang

* @date ${date} ${time} 

* @version V1.0   

*/

Types节点（类注释标签）

/** 

* @ClassName: ${type_name} 

* @Description: ${todo}(这里用一句话描述这个类的作用) 

* @author fsjohnhuang

* @date ${date} ${time} 

* 

* ${tags} 

*/

Fields节点（字段注释标签）

/** 

* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 

*/ 

Constructor节点（构造函数注释标签）

/** 

*

Title:

 

*

Description:

 

* ${tags} 

*/

Method节点（方法注释标签）

/** 

* @Title: ${enclosing_method} 

* @Description: ${todo}(这里用一句话描述这个方法的作用) 

* @param ${tags}  参数说明 

* @return ${return_type}    返回类型 

* @throws 

*/

Overriding Methods节点（覆盖方法注释标签）

/*

* Title: ${enclosing_method}

*Description: 

* ${tags} 

* ${see_to_overridden} 

*/

Delegate Methods节点（代理方法注释标签）

/** 

* ${tags} 

* ${see_to_target} 

*/ 

getter节点（getter方法注释标签）

/** 

* @return ${bare_field_name} 

*/

setter节点（setter方法注释标签）

/** 

* @param ${param} 要设置的 ${bare_field_name} 

*/

注意：此处要点击一个你欲添加的类型，并点击旁侧的 Edit 按钮才可编辑模版

           全部编辑完毕点击应用即可。

尊重原创，转载请注明来自：http://www.cnblogs.com/fsjohnhuang/p/3988883.html  ^_^肥仔John

四、注释文档模版的导入、导出

在 Window->Preference->Java->Code Style->Code Template → Import(导入) | Export (导出) 下可导入导出注释模板。

尊重原创，转载请注明来自：http://www.cnblogs.com/fsjohnhuang/p/3988883.html  ^_^肥仔John

五、我的测试实例

  可以通过鼠标点选相关的方法名，并按快捷键  Alt + Shift + j 来自动插入java的方法文档注释模版

希望能对您的编程开发能有所帮助，如需转载请注明博客链接 http://blog.csdn.net/woaittyx  ^_^ ，祝您生活愉快！