Java-模板注释

前言

好的代码规范是一个程序员的基本修炼，好的代码注释更能体现一个程序员的思维逻辑，虽然代码是用来给机器运行的，
我们只要能写出能让编译器运行的代码就行了，但是如果没有好的编码规范，到项目后期，加入开发的人员逐渐增多时，
每个人的编码风格都不一样，这就会让项目维护者很难维护，所以开始就要制定一些好的规范来让大家遵守，这样才能写
出可维护，健壮的项目。

约定

1、类模板注释

类注释(Class)主要用来声明该类用来做什么，以及创建者、创建日期版本、包名等一些信息

示例：

/**
 * <p>
 * 测试而言
 * <p>
 *
 * @className: Test
 * @author: xxx.xx
 * @create: 2020-11-13 16:57
 */

配置路径：

File->Setting->Editor->File and Code Templates->Class
File->Setting->Editor->File and Code Templates->Interface
File->Setting->Editor->File and Code Templates->Enum
File->Setting->Editor->File and Code Templates->AnnotationType

配置内容：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* <p>
* ${description}
* <p>
*
*@className: ${NAME}
*@author: xxx.xx
*@create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/
public XXX ${NAME} {
}

ps:复制模板的时候注意XXX类型

2、方法注释

方法注释(Methods)主要用来声明该类的作用、入参、返回值、异常等信息:

示例：

/**
 * 分页接口查询
 *        
 * @param page
 * @return {@link IPage<PageVO>}
 * @author jamel.li
 * @create 2020/11/13 17:18
 */
public IPage<PageVO> page(IPage<PageDTO> page) {
}

配置方式：

1.进入配置路径 File->Setting->Editor->LiveTemplates

2.点击右侧 “+” -> Template Group…-> 输入组名称 如“jamel” 点击ok

3.选中创建的 “jamel” 点击右侧 “+” -> Live Template

4.配置模板内容及快捷键截

模板内容

**
 * $end$
 *        
$param$
 * @return $return$
 * @author jamel.li
 * @create $date$ $time$
 */

变量填充（点击 Edit variables）

end | 
param | groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '')}; return result", methodParameters()) 
return | groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())
date | date()
time | time()

5.点击 Apply，在方法上使用时输入 “/**” 然后点击 tab键。注释就出来了