idea类与方法注释规范教程

1、类注释

修改下面蓝色字体为自己名称全拼，修改完后，复制下面红色字体，粘贴到

Settings->Editor->File and Code Templates->Files->Class右侧代码栏（全选覆盖）

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#parse("File Header.java")

/**  

* @Description:

* @author LiYongHai

* @Title: ${NAME}

* @Package ${PACKAGE_NAME}

* @date ${DATE}${TIME}

*/

public class ${NAME} {

}

 

2、方法注释

Settings->Editor->Live Templates 点击右侧+号新建分组名称为user

选中新建user组，点击右侧+号创建自定义注解

*

 * @Description:

 * @Author: LiDongHai

$param$

 * @Return: $return$

 * @Date: $DATE$ $TIME$

 */

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\\t\t' : '')}; return result", methodParameters())

methodReturnType()

date()

time()

3、方法注释应用

选择一个方法，在上方输入/**点击Tab间即可生成