idea添加作者注释和方法注释、属性注释

目录

[IDEA 设置类注释模板作者、日期、描述等信息(推荐标准!)](#IDEA 设置类注释模板作者、日期、描述等信息(推荐标准!))

二.方法注释

三.属性注释

四.方法步骤注释


IDEA 设置类注释模板作者、日期、描述等信息(推荐标准!)

1、新建类的时候自动添加类注释

打开设置

1.File-->settings-->Editor-->File and Code Templates-->Files

2.在class与interface加入注释模板

/**

*@ClassName ${NAME}

*@Description TODO

*@Author xxx

*@Date {DATE} {TIME}

*/

类注释添加完毕,新建则会生成注释

二.方法注释

1.File-->Settings-->Editor-->Live Templates

2.新建组:命名为userDefine 新建模板:命名为*

3.在模板内加入内容:

*
* @Description
* @Date time date
param
* @return return
**/

4.选择模板的应用场景,一般选择EveryWhere-->Java即可

5.设置参数的获取方式,选择右侧的Edit variables按钮

6.多参数时要用脚本来处理,复制下面这段代码到上面的位置

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

7.快捷键根据自己需求进行选择,设置完成

8.测试

在方法上面,先打出/* ,然后按下回车键Enter

三.属性注释

/**
* 注释内容
*/

四.方法步骤注释

//注释内容

相关推荐
Flittly15 小时前
【AgentScope Java新手村系列】(16)从RAG到多路检索
java·spring boot·spring
小兔崽子去哪了15 小时前
Java 生成二维码解决方案
java·后端
人活一口气19 小时前
从JVM调优到MCP协议:Java全栈技术体系深度总结与企业级架构实践
java·spring boot
NE_STOP21 小时前
Vibe Coding -- 完整项目案例实操
java
荣码21 小时前
GraphRAG:普通RAG只能回答"点"的问题,我踩了4个坑才搞懂
java·python
SimonKing21 小时前
Google第三方授权登录
java·后端·程序员
明月光81821 小时前
从一行 @Builder 说起:重新拾起 Java 的 Lombok、注解与 Builder 模式
java
考虑考虑1 天前
Mybatis实现批量插入
java·后端·mybatis
咖啡八杯1 天前
GoF设计模式——中介者模式
java·后端·spring·设计模式
青石路1 天前
记一次多JDK版本问题的排查,一坑套一坑,差点没爬上来
java