IDEA 注释配置

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/DanielAnton/article/details/89456175

一、类的模板

File–>Settings–>Editor–>File and Code Templates–>Files->Class

 同样的模板也可以配置Interface、Enum、AnnotationType等。

 二、为方法添加注释

File–>Settings–>Editor–>Live Templates

设置模板:

 选择右侧的Edit variables按钮,设置参数的获取方式:

其中,获取param参数使用到了groovyScript,参考了网上很多人写的,结果都有点瑕疵,修改了下,暂时没有发现什么问题;

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

 我在\\n的后面添加了一个\\t+空格,有一个问题是,创建注释的初始时,下面的参数会缩进一个tab,但是修改了description后,最后的效果是好的。

另外,对于如何获取throw参数,尚没有找到答案,欢迎告知。

设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可
(如果曾经修改过,则显示为change而不是define)

 

效果图

创建方法,在方法上使用/*+Enter即可

 

一开始,会这样,然后我们添加描述,最终的结果是这样

 

 嗯,只能说最后的效果是好的,先将就下吧。

展开阅读全文

没有更多推荐了,返回首页