类头注释
打开File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header
直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。
例如:
/**
* @ClassName ${NAME}
* @Description TODO
* @Author ${USER}
* @Date ${DATE} ${TIME}
* @Version 1.0
*/
(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间
(4)1.0:设置版本号,一般新创建的类都是1.0版本
方法注释
想使用 /**+Enter 手动为方法添加注释,先对方法注释模板进行配置
打开File -> Settings -> Editor -> Live Templates
(1)新建组:命名为 MyGroup (组名自定义)
(2)在这个group下新建模板LiveTemplate
(3)设置模板样式:
注意第一行,是 ** 而不是 /*。在设置参数名时必须用 $参数名$ 的方式,否则读取不到方法中的参数名
**
* @title $title$
* @Description TODO
* @author
$param$
* @return $return$
* @throws $throws$
* @CreateTime $date$ $time$
**/
(4)设置参数的获取方式
选择每个参数对应的获取方法(在下拉选择框中选择即可)
获取param时使用脚本的方式,将以下脚本复制进Expression
groovyScript(“def result=‘’; def params=”${_1}“.replaceAll(‘[\\[|\\]|\\s]’, ‘’).split(‘,’).toList(); for(i = 0; i < params.size(); i++) {if(params.size()==0) result += ‘\n’; result+=’ * @param ’ + params[i] + ((i < params.size() - 1) ? ‘\n’ : ‘’)}; return result”, methodParameters())
(5)设置模板的应用场景
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可
(如果曾经修改过,则显示为change而不是define)