idea生成类注释和方法注释的正确方法(网上整理可用)

最新推荐文章于 2023-02-02 14:37:44 发布

cheng43526899

最新推荐文章于 2023-02-02 14:37:44 发布

阅读量488

点赞数

分类专栏：开发相关文章标签： idea idea注释 idea模板

开发相关专栏收录该内容

9 篇文章 0 订阅

订阅专栏

生成类注释

打开Preferences ->Editor -> File and Code Templates -> Files -> Class
效果图

网上很多都是在Includes的File Header里面添加，在这里面添加还需要自己去移动下鼠标，然后再去操作键盘，再去写description，，直接在创建类的时候就添加好description

同理，也可以在这儿为你的Interface，Enum添加上注释

生成类注解模板

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
*@program: ${PROJECT_NAME}
*@description: ${description}
*@author: Joker
*@create: ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
*/
public class ${NAME} {
}

生成方法注释

打开Preferences ->Editor -> Live Templates -> 点击右边加号为自己添加一个Templates
Group -> 然后选中自己的Group再次点击加号添加Live Templates
然后设置自己喜欢的快捷键在Abbreviation里面记得在Applicable in 里面勾选,起码也要勾选class
修改 Abbreviation 为 * ，Template text 中添加模板。
添加方法注释模板
不要调整模板空格及对齐方式 , $p a r a m s$ 就是需要这样写！！！

*
* @Description: $description$ 
$params$ 
* @return: $returns$ 
* @Author: Joker 
* @Date: $date$ 
*/

在这里插入图片描述
4. 编辑模板参数

params的表达式为

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i<(params.size()-1)){result+='* @param ' + params[i] + ' : ' + '\\n'}else{result+='* @param ' + params[i] + ' : '}}; return result;}", methodParameters());