Myeclipse自定义注释

1、设置模板

Windows—Preference—Java—Code Style—Code Templates

图中， Configure generated code and comments中的每种被注释的类型，都可以在下面Pattern中预览其注释模板，如果需要修改，点击右上角的 edit 就可以修改成需要的格式。

修改时，@后面的内容为注释中需要原原本本显示的内容，${}中的内容都是系统定义的函数，用于显示类型名称——${type_name}，显示当前日期${date}，显示当前时间——${time}，自定义填写内容——${tags} 等。

如果选中最下面Automatically add comments for new metnods and types，则新建类的时候会自动生成类头注释。

2、在代码中生成注释

上面说到，设置好模板后，新建类的时候，可以设置为自动生成注释，但之后新添加的方法、字段什么的并不会自动出来注释，需要人工“干预一下”：

输入 /**

在VisualStudio中，如果是C#语言，在类或方法上部输入  ///  ；如果是VB.NET，输入  ‘‘‘ 。就可以为类或方法生成已经设置好的注释模板。

在MyEclipse中，在需要被注释的代码区（如类或方法）上部输入 /** ，回车，就可以为类或方法生成已经设置好的注释模板。

快捷键

如果您有使用快捷键的好习惯，这种方法当然是最顺手的：把光标定位到需要被注释的代码区（如类或方法）上部，快捷键 Shift+Alt+j
即可搞定。

为setter、getter生成注释

当一个类中需要生成多个setter和getter方法时，为了方便，可以在生成setter和getter的窗口选中Generate method comments来生成注释：

例如：

文件 (Files) 注释标签：

/**

* @Project : ${project_name}

* @Title : ${file_name}

* @Package ${package_name}

* @Description : ${todo}

* @author shenyanghong ahong2011@gmail.com

* @date ${date} ${time}

* @Copyright : ${year} www.1000chi.com Inc. All rights reserved.

* @version V1.0

*/

类 (Types) 注释标签（类的注释）：

/**

* @ClassName ${type_name}

* @Description ${todo}

* @author shenyanghong ahong2011@gmail.com

* @date ${date}

* ${tags}

*/

字段 (Fields) 注释标签：

/**
* @Fields ${field} : ${todo}
*/

构造函数标签：

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

方法 (Constructor & Methods) 标签：

/**
* @Title: ${enclosing_method}
* @Description: ${todo}
* @param ${tags}    设定文件
* @return ${return_type}    返回类型
* @throws
*/

覆盖方法 (Overriding Methods) 标签：

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

代表方法 (Delegate Methods) 标签：

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

getter 方法标签：

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

setter 方法标签：

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

---