eclipse文档注释设置、文件(Files)注释标签、类型(Types)注释标签（类的注释）、字段(Fields)注释标签、构造函数(Constructor)标签

原创已于 2022-07-30 10:25:04 修改 · 1.5k 阅读

13 ·

CC 4.0 BY-SA版权

文章标签：

#eclipse #java #servlet

于 2022-07-21 16:40:59 首次发布

java 专栏收录该内容

42 篇文章

订阅专栏

本文详细介绍了如何在Java项目中设置文件、类型、字段、构造函数、方法、覆盖方法、代理方法、getter和setter的注释模板，助您提升代码规范性和可读性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文将每一个元素逐一给大家介绍一下。

在这里插入图片描述

1.文件(Files)注释标签

/**  
 * @Title: ${file_name}
 * @Description: 
 * @author Redamancy
 * @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')} 
 */

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

/**  
 * @ClassName: ${type_name}
 * @Description: 
 * @author Redamancy
 * @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')} 
*/

3.字段(Fields)注释标签

/**  
 * @Fields ${field}
 * @Description: 
 * @author Redamancy
 * @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')} 
 */

4.构造函数(Constructor)标签

/**  
 * @Constructor: ${enclosing_type}
 * @Description: ${enclosing_type}构造函数
 * @author Redamancy
 * @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')} 
 */

5.方法(Methods)标签

/**  
 * @MethodName: ${enclosing_method}
 * @Description: ${todo}
 * @author Redamancy
 * @return ${return_type}
 * @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')} 
 */

6.覆盖方法(Overriding Methods)标签

/**  
 * @MethodName: ${enclosing_method}
 * @Description: ${todo}
 * @author Redamancy
 * ${tags}
 * ${see_to_overridden}
 * @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')} 
 */

7.代理方法(Delegate Methods)标签

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

8.getter方法标签

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

9.setter方法标签

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