IDEA JAVA文档注释和方法注释模板
文档注释
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @ClassName ${NAME}
* @Description ${Description}
* @Author ${USER}
* @Date ${DATE} ${TIME}
* @Version V1.0
*/
public class ${NAME} {
}
- $ {NAME}和class后面的${NAME}相同,得到类名
-
${Description}在创建类是会要你添加描述
-
${USER}是主机名,可以在idea安装包的bin下的idea.exe.vmoptions进行更改(64位操作系统为idea64.exe.vmoptions),在里面添加-Duser.name=xxx即可,这样idea识别的主机名就是自己定义的了
-
${DATE} ${TIME}是时间和日期
-
@Version V1.0 这是项目的版本,一般为1.0
方法注释
这里是定义模板的地方
-
自己创建模板组
-
自定义名称
-
添加模板
-
编写模板
我这里设置的快捷键是**,然后输入/和这个之后按tab就可以生成注释了
**
* @Author LiangHui
* @Description $description$
* @Date $time$ $date$
$params$
* @return $return$
*/
然后是变量设置
params有所不同,要自己手动输入
groovyScript("def result='';def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {num = params.size();if(num==1){result ='* @param ' + params[i] + ' ';}else{ if(i==0){ result ='* @param ' + params[i] + ' \\n'; }else{ result +=' * @param ' + params[i] + ((i < num - 1) ? ' \\n' : ' '); } }}; return result", methodParameters())
最后还要设置使用范围
已经设置的点击Change可以更改,没有设置的也在同样的位置可以设置
输入/** + tab 生成注释,虽然param没有对齐,但是当输入方法描述或者按tab、enter就会自动对齐了