IDEA自定义文件头注释/方法注释

类头注释

打开File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header
在这里插入图片描述
直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。
例如:

 /**
 * @ClassName ${NAME}
 * @Description TODO
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */

(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间
(4)1.0:设置版本号,一般新创建的类都是1.0版本

方法注释

想使用 /**+Enter 手动为方法添加注释,先对方法注释模板进行配置
打开File -> Settings -> Editor -> Live Templates
在这里插入图片描述
(1)新建组:命名为 MyGroup (组名自定义)
在这里插入图片描述
在这里插入图片描述
(2)在这个group下新建模板LiveTemplate
(3)设置模板样式:
注意第一行,是 ** 而不是 /*。在设置参数名时必须用 $参数名$ 的方式,否则读取不到方法中的参数名

**
 * @title $title$
 * @Description TODO 
 * @author 
$param$
 * @return $return$
 * @throws $throws$
 * @CreateTime $date$ $time$
 **/ 

(4)设置参数的获取方式
在这里插入图片描述
选择每个参数对应的获取方法(在下拉选择框中选择即可)
在这里插入图片描述
获取param时使用脚本的方式,将以下脚本复制进Expression

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

(5)设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可

(如果曾经修改过,则显示为change而不是define)
在这里插入图片描述

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
idea2022 类文件注释是指在一个 Java文件的开部分添加一段注释内容,用于描述这个类的基本信息、功能、作者和版本等相关信息。 一般情况下,一个类文件注释应包含以下内容: 1. 文件名和位置:注释应该标明这个类文件文件名以及存放位置,以方便其他开发人员在需要时能够快速定位到这个文件。 2. 类名和包名:注释应该标明这个类的类名和所属的包名,以方便其他开发人员在阅读代码时能够准确地了解这个类的功能。 3. 功能描述:注释应该简要地描述这个类的主要功能和用途,以便其他开发人员在使用这个类时能够知道它的作用。 4. 作者信息:注释应该标明这个类的作者姓名以及编写日期,以方便其他开发人员在需要时能够联系到作者并了解代码的编写背景。 5. 版本信息:注释应该标明这个类的版本信息,包括版本号、修改日期等,以便其他开发人员在进行版本迭代时能够清楚地了解代码的变更历史。 一个典型的类文件注释的例子如下: ``` /** * 文件名: Idea2022.java * 位置: com.example * 类名: Idea2022 * 包名: com.example * * 功能描述: 这个类是用于实现某个功能的核心类,主要用于处理某些特定业务逻辑。 * * 作者: 张三 * 编写日期: 2022年1月1日 * * 版本: 1.0 * 修改日期: 2022年1月10日 */ ``` 通过在类文件部添加注释,可以使代码更具可读性和可维护性,方便他人理解和使用代码,并减少开发过程中的沟通成本。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值