IDEA 设置文档注释
1、参考资料
2、类文档注释
2.1、设置类文档注释模板
在【File and Code Templates】页面设置类(Class)的文档注释
/**
*@ClassName ${NAME}
*@Description TODO
*@Author ${USER}
*@Date ${DATE} ${TIME}
*@Version 1.0
*/
2.2、使用类文档注释
注意:只有新建类的时候,才能创建类的文档注释哦
3、设置接口文档注释
3.1、设置接口文档注释模板
同样的方法,在【File and Code Templates】页面设置接口(Interface)的文档注释
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
*@InterfaceName ${NAME}
*@Description TODO
*@Author Oneby
*@Date ${DATE} ${TIME}
*@Version 1.0
*/
public interface ${NAME} {
}
3.2、使用接口文档注释
注意:只有新建接口的时候,才能创建接口的文档注释哦
4、方法文档注释
4.1、设置方法文档注释模板
-
在【Live Templates】中新建一个模板
-
默认会新建一个名为 user 的分组(我也懒得改名字了)
Abbreviation:*
表示在方法上输入*
,再敲击 Enter 就能出现方法文档注释- Description:为方法添加文档注释
- Template Text:模板内容
- Applicable in Java:仅在 Java 文件中生效
-
为模板上的变量添加默认值
-
方法文档注释的模板
** * @description: $description$ $params$ * @return: $returns$ * @author Oneby * @date: $date$ $time$ */
-
params
的default value
: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())methodParameters())
4.2、使用方法文档注释
Nice~~~