给eclipse或myeclipse添加自定义的注释(类和方法)

eclipse或myeclipse自定义注释(类和方法)

1.前言

　　Eclipse作为JavaIDE（Integrated Development Environment,集成开发环境）,可以通过设置自动添加Javadoc注释信息，如@author 作者名、@version 版本标识、@date 日期等，在创建类或新增方法时会自动添加注释信息。

首先介绍几个常用的注解：

@author 作者名

@date 日期

@version 版本标识

@parameter 参数及其意义

@return 返回值

@throws 异常类及抛出条件

@deprecated 引起不推荐使用的警告

@override 重写

这个注解我们在java代码中经常可以看到。

2.添加注释操作

设置注释模板的步骤：打开eclipse，点击菜单栏上的Window –>Preferences–>Java–>Code Style –>Code Templates，对右侧Comments选项中具体的注释信息进行编辑即可。
可勾选上自动添加注释信息，在生成java文件时便会自动生成注释，当然也可以手动插入注释。设置的界面如下：

3.注释模板

具体的Comment内容设置（注释模板）：

1、点击Comments下的Files可对整个Java文件进行注释：
包括公司名称，版权所属，作者信息，日期等。

/**  
* Title: ${file_name}  
* Description: 
* @author：邹涛/zoutao 
* @date ${date}
* @version 1.0
* Company: www.zoutao.info
*/  

2、点击Types对类进行注释：

/**
 *@class_name：${type_name}
 *@comments:
 *@param:
 *@return: 
 *@author:邹涛/Zoutao
 *@createtime:${date}
 * ${tags}
 */

3、点击Fields对字段进行注释：

/** ${field}*/

4、点击Constructors对构造方法进行注释：

/**  
* Title: 
* Description: 
* ${tags}
* @author：邹涛/zoutao 
* @date ${date}
* @version 1.0
*/  

5、点击Methods对方法进行注释：

/**  
 * @Title: ${enclosing_method}  
 * @Description:
 * ${tags}
 * @author：邹涛/zoutao 
 * @date ${date}
 * @version 1.0
 */  

6、 点击Overriding Methods对重写方法进行注释：

/* (non-Javadoc)
 * <p>Title: ${enclosing_method}p>  
 * <p>Description: p>  
 * ${tags}  
 * ${see_to_overridden}  
 */

7、Delegate methods对代表方法进行注释：

/**
 * ${tags}
 * ${see_to_target}
 */

8、Getters对get方法进行注释：

/**
 * @return the ${bare_field_name}
 */

9、Setters对set方法进行注释：

/**
 * @param ${param} the ${bare_field_name} to set
 */

下面的是我常用的注释模板。

1. 类的注释

第一步：找到Window→Preferences→java→Code Style→Code Templates→Comments→Types

第二步：点击右边的 Edit 编辑，我常用的模板是:

/**  
* @Title: ${file_name}
* @Package:${package_name}
* @Description:(作用)
* @author:Zoutao 
* @date:${date}
* @version:V1.0  
*/

Title后边可以自己编辑，也可以点击Insert Variable自己选择插入，其他的同理可改，修改完了以后点击OK保存。

第三步：在java页面下使用方式，输入“ /** ” 然后敲回车键，或者直接 Shift + Alt + J 就会自动生成。

图示：

2. 方法的注释

同样打开设置界面，找到Methods，然后Edit 编辑Methods，我用的模板是：

/**
 * @Description:(作用)
 * @param:${tags}   
 * @return:${return_type}  
 * @author:Zoutao
 * @date:${date}
 * @version:V1.0
 */

Title后边可以自己编辑，也可以点击Insert Variable自己选择插入，其他的同理可改，修改完了以后点击OK保存。

在java页面下输入 “ /** ” 然后敲回车键 就会自动出现。

图示：

其他的不常用，我也就喜欢这两个模板。自己也是这么用的。

---