myeclipse中java注释格式设置

Eclipse注释规范模版总结

一、具体操作

（1）在eclipse中，打开Window->Preference->Java->Code Style->Code Template

（2）然后展开Comments节点就是所有需设置注释的元素，参照下面注释规范对应设置即可

二、注释规范

1、文件(Files)注释标签

/**
* FileName:         ${file_name}
* @Description:     ${todo}
* @author:            crane-yuan
* @version            V1.0
* Createdate:      ${date}     ${time}
* Copyright:        Copyright(C) 2016-2017
* Company           CY.
* All rights Reserved, Designed By crane-yuan

* Modification  History:
* Date         Author        Version        Discription
* ---------------------------------------------------------------------------
* ${date}     crane-yuan       1.0             1.0

* Why & What is modified:

*/

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

/**
* @ClassName:       ${type_name}
* @Description:    ${todo}
* @author:            crane-yuan
* @date:            ${date}        ${time}
*/

3、字段(Fields)注释标签：

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

4、构造函数(Constructor)注释标签：

/**
* @Title:            ${enclosing_type}
* @Description:    ${todo}
* @param:            ${tags}
* @throws
*/

5、方法(Methods)标签：

/**
* @Title:             ${enclosing_method}
* @Description:     ${todo}
* @param:             ${tags}
* @return:         ${return_type}
* @throws
*/

6、覆盖方法(Overriding Methods)标签:

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

7、代表方法(Delegate Methods)标签：

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

8、getter方法标签：

/**
* @Title:            ${enclosing_method} <BR>
* @Description:      ${todo} <BR>
* @return:         ${field_type} <BR>
*/

9、setter方法标签：

/**
* @Title:          ${enclosing_method} <BR>
* @Description:     ${todo} <BR>
* @return:         ${field_type} <BR>
*/