注释模板

发表于 分类于

Javadoc - 维基百科

Java 文档注释（Javadoc注释）

异常注释用 @exception 或 @throws 表示，在 JavaDoc 中两者等价。

Eclipse

设置注释模板的入口：Window -> Preference -> Java -> CodeStyle -> Code Template 然后展开Comments节点就是所有需设置注释的元素。

image-20200702170321657

手动设置

文件(Files)注释模板

1
2
3
4
5
6
7
8
9
10
11
/**
 * Copyright ©${year} 公司名字. All rights reserved.
 *
 * @Title ${file_name}			# 可删
 * @Prject ${project_name}		# 可删
 * @Package ${package_name}		# 可删
 * @Description ${todo}			# 可删
 * @author ${user}				# 可删
 * @since ${date} ${time}		# 可删
 * @version V1.0				# 可删
 */

类型(Types)注释模板

类、接口、枚举的注释

1
2
3
4
5
6
7
8
/**
 * ${todo}
 * 
 * @author ${user}
 * @date ${DATE} ${TIME} -- 此标签Javadoc中不存在，不参与Javadoc生成，供开发人员查看具体日期，可选的。
 * @version 1.0.0 -- 版本。提供软件版本，每个类或接口最多一个。
 * @since 1.0.0 -- 起始。描述此功能首次存在的时间。
 */

字段(Fields)注释模板

1
2
3
/**
 * ${todo}
 */

构造函数(Constructors)模板

1
2
3
4
5
/**
 * ${todo}
 * 
 * ${tags}
 */

方法(Methods)模板

1
2
3
4
5
6
/**
 * ${todo}
 * 
 * ${tags}
 * @return ${return_type}		# 可删
 */

覆盖方法(Overriding Methods)模板

1
2
3
/* (non-Javadoc)
 * ${see_to_overridden}
 */

代表方法(Delegate Methods)模板

1
2
3
4
/**
 * ${tags}
 * ${see_to_target}
 */

getter方法模板

1
2
3
/**
 * @return the ${bare_field_name}
 */

setter方法模板

1
2
3
/**
 * @param ${param} the ${bare_field_name} to set
 */

导入 xml 配置

可以从网上下载配置好的 .xml 文件导入。

生成注释

一：快捷键

使用快捷键 Alt+Shift+J 快速生成文档注释。

二：创建类时生成

image-20200702165928871

IDEA

类、接口、枚举注释模板

该模板会在新建类型文件时自动添加。

image-20250219112012993

image-20250219111839756

1
2
3
4
5
6
7
8
/**
 * ${TODO}
 * 
 * @Author ${USER}
 * @Date ${DATE} ${TIME} -- 此标签Javadoc中不存在，不参与Javadoc生成，供开发人员查看具体日期，可选的。
 * @Version -- 版本。提供软件版本，每个类或接口最多一个。
 * @Since -- 起始。描述此功能首次存在的时间或版本。
 */

类型文件注释模板(自定义)

Live Templates (实时模板) 可以帮助我们更加高效的写一些固定模式的代码，以提高编码效率。同时也可以自定义代码模板。

推荐链接： 代码生成利器：IDEA 强大的 Live Templates

1、File -> Settings -> Editor -> Live Templates

2、新建组：命名为 user

3、新建模板：起个名，比如 cc (类注释 Class Comment)，mc (方法注释 Method Comment)。

image-20250219114050940

image-20250219114531407

模板内容：

1
2
3
4
5
6
7
8
9
10
**
 * $description$
 * 
 * Notes 特别需要注意的信息
 * 
 * @Author $user$
 * @Date $DATE$ $TIME$ -- 此标签Javadoc中不存在，不参与Javadoc生成，供开发人员查看具体日期，可选的。
 * @Version -- 版本。提供软件版本，每个类或接口最多一个。
 * @Since -- 起始。描述此功能首次存在的时间或版本。
 */

使用：

1
在类型文件头部：/cc+Enter

方法注释模板(自定义)

步骤同上…

模板一

模板内容：

1
2
3
4
5
6
7
**
 * $description$
 * 
 * @param $param$
 * @return $return$
 * @throws $throws$
 */

设置模板变量表达式：

image-20200706181518617

使用：

1
在方法头部：/mc+Enter

结果：

image-20200706181319085

模板二

修改模板一内容如下：

1
2
3
4
5
6
7
**
 * $description$
 * 
$param$
 * @return $return$
 * @throws $throws$
 */

修改 param 变量的表达式为自定义 groovyScript 脚本：

1
groovyScript("def result='';def flag=false;def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if (!params[i].equals('')) {flag=true;result+='* @param ' + params[i] + ' ' + params[i] + ((i < params.size() - 1) ? '\\n\\t ':'')} else {result+=' *'}}; return flag ? ' *\\n\t ' + result : result", methodParameters())

结果：

image-20210822140710496