Eclipse Java代码注释模板的设置

注释模板的设置

我们打开

Window->Preference->Java->Code Style->Code Template

然后展开Comments节点就是所有需设置注释的元素啦。

单行(single-line)注释：“//……”
块(block)注释：“/*……*/”
文档注释：“/**……*/”
javadoc注释标签语法

@author 对类的说明标明开发该类模块的作者

@version 对类的说明标明该类模块的版本

@see 对类、属性、方法的说明参考转向，也就是相关主题

@param 对方法的说明对方法中某参数的说明

@return 对方法的说明对方法返回值的说明

@exception 对方法的说明对方法可能抛出的异常进行说明

@return_type返回类型

@date 日期

@time时间

文件(Files)注释标签：

/**

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}

* @author xuwt

* @date ${date} ${time}

* @version V1.0

*/

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

/**

* @ClassName: ${type_name}

* @Description: ${todo}

* @author xuwt

* @date ${date} ${time}

*

* ${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)标签：

/* (no 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}

*/