都 2022 了，不会还有人不会 idea 注释相关的配置吧，速进本文

2022 年 5 月 03 日
本文字数：839 字
阅读完需：约 3 分钟

👨🏻‍🎓博主介绍：大家好，我是芝士味的椒盐，一名在校大学生，热爱分享知识，很高兴在这里认识大家🌟🌈擅长领域：Java、消息中间件、大数据、运维。
🙏🏻如果本文章各位小伙伴们有帮助的话，🍭关注+👍🏻点赞+🗣评论+📦收藏。
🤝另本人水平有限，旨在创作简单易懂的文章，在文章描述时如有错，恳请各位大佬指正，在此感谢！！！

缘由

相信大家在写代码的时候，为了可以让自己明白以及他人可以明白，都会都在项目代码中加上注释，写注释也是有讲究的，注释分为两种，一种类注释，另一种方法注释。

就拿上图中来说，类和方法的注释使用//简单的注释了一下，两个均是使用同一种方式的注视，显然有许多问题，比如：类创建的时间、类编写的作者、方法编写的时间、方法的作者，这些在一个大型项目中多人开发是有必要的，即使现在仅仅是练习项目也要打好良好的注释习惯。

注释模版理想状态

如上图所示的注释模版是不是很美观，又醒目，谁不爱呢？接下来将为大家提供 idea 的配置方式。

注释模版配置

类注释配置（记得保存点击 ok 哦）

注释代码：

  /**    * <p>    *     TODO    * </p>    *    * @author ${USER}    * @since ${DATE}   */

复制代码

点击 ok 确定之后，我们创建一个类来看看，就可以看到效果

方法注释配置（记得保存点击 ok 哦）

Template text:

  **   * <p>    *     TODO   * </p>   * @author  $user$   * @date    $date$ $time$  $params$   * @return  $returns$  */

复制代码

params:

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

复制代码