快捷搜索: 王者荣耀 脱发

IDEA添加自动注释(类注释及方法注释)

一、添加类自动注释

    左上角选择 File -> Settings -> Editor -> File and Code Templates; 然后选择Includes,点击“+”号新建文件,内容如下:
/**
*@description:TODO
*@author: ${USER}
*@create: ${DATE} ${TIME}
*/
    选择Files -> Class,在类声明上填入以下内容,并勾选Enable Live Templates 开启此模板
#if (${
          
   PACKAGE_NAME} && ${
          
   PACKAGE_NAME} != "")package ${
          
   PACKAGE_NAME};#end
#parse("File Header.java")
public class ${
          
   NAME} {
          
   
}
    或者直接将上面注释模板替换 #parse(“File Header.java”)

二、添加类方法自动注释

    左上角选择 File -> Settings -> Editor -> Live Templates; 点击“+”号,选择Template Group; 输入任意名称; 创建完成后,自动定位到刚创建的组,点击右上角,选择Live Template; 自定义任意的Abbreviation,这里为了以后操作快捷,直接填写a,Template Text 内填入以下内容:
/**
 - @author: $author$
 - @date: $date$ $time$
 - @description: TODO
$params$
 - @return $returns$
 */
    选择适用范围,选择java,点击打勾;(需要先进行这步再配置变量,不然配置变量系统方法无法显示) 然后点击Edit variables ,配置变量。 其中,params为方法入参数,这里需要配置groovyScript函数,将下面的内容拷贝到Expression,复制完成后请按回车。
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) ? \n : )}; return result", methodParameters())
    使用方法:在方法上部输入a,按Tab键 存在的两个问题: 生成的时候如果不在方法体内,入参如果不是vo等java类,就获取不到。 解决:建议在方法体内生成,然后移到方法上面; 方法体外生成的位置必须是方法上部一行,如果在@Override上面使用就获取不到入参和返回值。 解决:先生成注释,然后再把@Override等方法注解移到下面。
经验分享 程序员 微信小程序 职场和发展