IntelliJ IDEA方法注释模板设置（全面和人性化）

咦灬土豆

已于 2022-03-30 14:31:02 修改

阅读量5.3k

点赞数

CC 4.0 BY-SA版权

分类专栏：工具使用

于 2019-05-28 10:24:25 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_43124843/article/details/90634294

工具使用专栏收录该内容

5 篇文章

订阅专栏

博客介绍了代码注释生成的快捷键，使用 /** 再按 enter 可生成注释。强调模板第一个星号要比其他的进一个空格以保证对齐。还提到参数编辑时，若下拉无选项，需先指定应用语言范围再编辑，此外还涉及参数 param 的脚本等内容。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

使用时候快捷键用 /** 再按enter就会生成注释
在这里插入图片描述
注意：下面模板第一个星号比下面其他的向前进一个空格，这样才能保证生成的对齐
模板代码

*
 * <strong>Title : $Title$<br>
 * </strong> <strong>Description : $TODO$TODO</strong><br>
 * <strong>Create on : $DATE$ $TIME$<br>
 * </strong>
 * <p>
 *  $param$
 * @return $return$
 * @throws $throw$
 * @author Li<br>
 * @version <strong> </strong><br>
 *          <br>
 *          <strong>修改历史:</strong><br>
 *          修改人 | 修改日期 | 修改描述<br>
 *          -------------------------------------------<br>
 *          <br>
 *          <br>
 */

参数的编辑
点开编辑这里时候下拉没有选项的话，需要先指定应用的语言范围，再进来编辑就有了

在这里插入图片描述
参数param的脚本

groovyScript("def result=''; def stop=false; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {result +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param: ' + params[i] + '\\r\\n' : ' * @param: ' + params[i] + '')}; }; return result;", methodParameters())

在这里插入图片描述