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

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

在这里插入图片描述

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

@[TOC]

缘由

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

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

注释模版理想状态

在这里插入图片描述

  • 如上图所示的注释模版是不是很美观,又醒目,谁不爱呢?接下来将为大家提供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之后就会显现如下的方法注释模版

在这里插入图片描述

  • 到这里基本配置就完毕了,在对应的注释元素写下消息即可!!!
  • 点击注释的行号旁边的小图标可以更加简洁的显示注释信息

在这里插入图片描述

相关文章
|
3天前
|
Java
Idea自动生成注释
Idea自动生成注释
18 6
Idea自动生成注释
|
3天前
|
Java Maven
Idea配置项目的热启动
Idea配置项目的热启动
31 5
Idea配置项目的热启动
|
2月前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
29天前
|
前端开发 Java 开发工具
Git使用教程-将idea本地Java等文件配置到gitte上【保姆级教程】
本内容详细介绍了使用Git进行版本控制的全过程,涵盖从本地仓库创建到远程仓库配置,以及最终推送代码至远程仓库的步骤。
38 0
|
4月前
|
Java
IDEA 利用groovy脚本生成注释
【10月更文挑战第29天】在 IntelliJ IDEA 中,可以通过创建和运行 Groovy 脚本来自动生成 Java 类方法的 Javadoc 注释。首先,创建一个 Groovy 文件并编写脚本,该脚本会检查每个方法是否已有注释,如果没有,则生成包含方法描述、参数列表和返回值的基本注释。接着,通过“Tools”菜单下的“Groovy Console”运行脚本,确保脚本中的包版本与当前使用的 IntelliJ IDEA 版本匹配。运行后,脚本将自动为选定类的方法添加注释。建议在执行前备份代码,以防意外。
145 2
|
3月前
|
Linux 网络安全 开发工具
IDEA如何配置git和github
【11月更文挑战第14天】本指南详细介绍了如何在 IntelliJ IDEA 中配置 Git 和 GitHub,包括检查和设置 Git 路径、测试配置,以及通过 SSH 或 HTTPS 方式配置 GitHub 仓库的具体步骤。完成配置后,用户可在 IDEA 中轻松进行版本控制操作。
464 0
|
4月前
|
SQL 存储 关系型数据库
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
84 2
|
4月前
|
Oracle IDE Java
IDEA安装教程配置java环境(超详细)
IDEA安装教程配置java环境(超详细)
2018 1
|
4月前
|
Java Maven
震惊!idea专业版如何配置maven国内源手把手教学
文章提供了如何在IDEA专业版中配置Maven使用国内源(如阿里云)的详细步骤,以加快依赖下载速度,并解释了配置国内源的原因。
914 0
震惊!idea专业版如何配置maven国内源手把手教学
|
5月前
|
XML Java Maven
idea配置maven步骤及常见问题
本文介绍了在IDEA中配置Maven的详细步骤,包括Maven的下载、系统环境变量的配置、Maven本地仓库的设置、镜像加速的配置,以及在IDEA中指定Maven路径和配置文件。同时,还提供了解决每次新建项目需要重新手动配置Maven问题的方法。
idea配置maven步骤及常见问题

热门文章

最新文章