一、自定义类注释
打开idea ,进入偏好设置,点击Editor => File an Code Templates,点击class:
在右侧的空白区域内编辑以下内容:
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* className ${NAME}
* description
* @author
* @date ${DATE} ${TIME}
* @copyright (c) ${YEAR}, all rights reserved
**/
public class ${NAME} {
}
其中/** **/就是我们的类注。
当我们创建某一个类时,该注释就会自动生成
二、方法注释
打开idea ,进入偏好设置,点击Editor => Live ,点击右边的 + 号 ,选择第一项:
首先,将顶部By default expand with 改为Enter(个人习惯,也可以使用Tab或者其他)
然后填写Abbreviation 和 Description,内容如下(description可以自己写,Abbreviation建议跟着图片上面一致,不然可能会导致没有效果):
然后添加Template text,如图示:
其具体内容为(注意格式不要变,里面的内容可以根据自己的情况填写):
*
*@description
*@author
*@date $date$ $time$
$params$
*@return $return$
*/
然后点击右侧的Edit variables:
如图所示:
其中params 需要编写脚本,内容如下:
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) ? '\\r\\n' : '')}; return result", methodParameters())
然后点击保存就好了。
我们在方法上面输入 /** 后点击Enter(根据刚才自己设置的为准)
效果图如下: