idea java 注释模板配置

在网上找了好久,好多的文章都有一个共同的病点就是“@param注释当有多个参数时候,全部放在了一行里面”,非常不友好。

以下是我整理好的,完全按照eclipse的注释风格。

!!!先看最后实现的效果图,如下:(eclipse代码的“作者”、“时间”放在同一行,idea分开两行,这个不影响,可以自行调整。)

      

---------------------------------------------------------------------------------------------------分割线-------------------------------------------------------------------------------------------------------------------------------------

实现步骤:

   !!!!!按照图中流程来即可。最下面会给出图片文本内容。

   ---------------------------------------------------------------------------------------------------分割线-------------------------------------------------------------------------------------------------------------------------------------

以上图片需要的文本内容如下:

-------------------------------------------------

第7步文本:

*
 * @author wulm
 * @date $date$ $time$
$param$$return$ * @desc 
 **/


-----------------------也可以将“@desc”提到前面,如下所示:----------------------------------


*
* @desc
* @author wulm
* @date $date$ $time$
$param$$return$ **/

-------------------------------------------------

第10步文本:

date::::::date()
time::::::time()
param::::::groovyScript("def result=''; def params="${_1}".replaceAll('[\\[|\\]|\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((params.size()<=1 && params[i]=='')? '' : '\n')}; return result==' * @param '?'':result", methodParameters())
return::::::groovyScript("def returnType="${_1}"; return returnType=='void'?'':' * @return \n'", methodReturnType())

完毕!!!!!!!!!!!!!!!!!!!!!!!!!!!!

完毕!!!!!!!!!!!!!!!!!!!!!!!!!!!!

完毕!!!!!!!!!!!!!!!!!!!!!!!!!!!!

 

此时idea的方法注释已经和eclipse完全一致了。只是使用了“表达式”groovyScript来实现的。

 ---------------------------------------------------------------------------------------------------分割线-------------------------------------------------------------------------------------------------------------------------------------

如果想要在创建类文件的时候加上类注释,可按照下面设置即可。

 上图的第四步文本:

/**
 * @author wulm
 * @date ${DATE} ${TIME}
 * @version 1.0.0
 * @desc 
 */

好了到此结束!

参考:

https://www.cnblogs.com/godtrue/p/8667821.html

原文地址:https://www.cnblogs.com/wulm/p/10923596.html