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

在这里插入图片描述

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

文章目录

• • • • 缘由
      • 注释模版理想状态
      • 注释模版配置
      • • 类注释配置（记得保存点击ok哦）
        • 方法注释配置（记得保存点击ok哦）

缘由

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

在这里插入图片描述

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

注释模版理想状态

在这里插入图片描述

• 如上图所示的注释模版是不是很美观，又醒目，谁不爱呢？接下来将为大家提供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())

我们在任意一个类里写一个方法，并且在方法的上面输入/*加Enter

在这里插入图片描述

执行/*加Enter之后就会显现如下的方法注释模版

在这里插入图片描述

到这里基本配置就完毕了，在对应的注释元素写下消息即可！！！

点击注释的行号旁边的小图标可以更加简洁的显示注释信息

在这里插入图片描述

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。

发布者：全栈程序员栈长，转载请注明出处：https://javaforall.cn/187458.html原文链接：https://javaforall.cn