都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之后就会显现如下的方法注释模版

在这里插入图片描述

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

在这里插入图片描述

相关文章
|
1月前
|
Java Maven
Maven配置以及IDEA设置(Cannot resolve plugin org.apache.maven.plugins:报错)
Maven配置以及IDEA设置(Cannot resolve plugin org.apache.maven.plugins:报错)
82 1
|
5天前
|
SQL 分布式计算 大数据
MaxCompute产品使用合集之如何在本地IDE(如IntelliJ IDEA)中配置MaxCompute (mc) 的任务和调试SQL
MaxCompute作为一款全面的大数据处理平台,广泛应用于各类大数据分析、数据挖掘、BI及机器学习场景。掌握其核心功能、熟练操作流程、遵循最佳实践,可以帮助用户高效、安全地管理和利用海量数据。以下是一个关于MaxCompute产品使用的合集,涵盖了其核心功能、应用场景、操作流程以及最佳实践等内容。
|
11天前
|
开发工具 git
mac git配置 idea
mac git配置 idea
|
11天前
idea 自动加头部注释
idea 自动加头部注释
|
22天前
|
Java Maven
idea 配置国内源
idea 配置国内源
31 0
|
29天前
|
IDE Go 开发工具
【GO基础】2. IDEA配置Go语言开发环境
【GO基础】2. IDEA配置Go语言开发环境
|
1月前
|
存储 IDE Java
IntelliJ IDEA 安装及配置详细教程
IntelliJ IDEA 安装及配置详细教程
189 0
|
1月前
|
Unix Shell 开发工具
windows下如何安装git以及IDEA如何配置git
该文指导安装Git 2.15.0版本。首先从Git官网下载最新安装包,双击安装,依次选择Next,同意默认配置,确保勾选添加到环境变量。在配置选项中,选择在cmd中使用Git(第2项),行结束转换选Windows(第1项),终端模拟器选MinTTY(第1项)。安装完成后,通过右键菜单或直接打开Git Bash验证安装成功。最后,配置全局用户名和邮箱,并在IDEA中设置Git路径以完成集成。
|
1月前
Mac上IntelliJ IDEA设置类注释和方法注释带作者和日期
Mac上IntelliJ IDEA设置类注释和方法注释带作者和日期
|
1月前
idea生成方法注释的正确方法
idea生成方法注释的正确方法