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 ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

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

8.测试

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

三.属性注释

/**
* 注释内容
*/

四.方法步骤注释

//注释内容

相关推荐
lcreek3 小时前
Java 反序列化漏洞深度解析(一):从URLDNS到真正的DNS探测
java·反序列化漏洞
杰克尼3 小时前
天机学堂复习总结(day03-day04)
java·开发语言·redis·elasticsearch·spring cloud
x***r1513 小时前
jdk-11.0.16.1_windows使用步骤详解(附JDK 11环境变量配置与验证教程)
java·开发语言·windows
弹简特4 小时前
【Java项目-轻聊】01-项目演示+项目介绍+准备工作+项目源码
java
luck_bor4 小时前
File类&递归作业
java·开发语言
武子康5 小时前
Java-07 深入浅出 MyBatis数据库一对多关系模型实战:表结构设计与查询实现
java·后端
REDcker7 小时前
Linux OverlayFS详解
java·linux·运维
Gene_20227 小时前
ubuntu22.04在vscode使用codex
ide·vscode·编辑器
Royzst7 小时前
xml知识点
java·服务器·前端
鱼鳞_7 小时前
苍穹外卖-Day08(缓存套餐)
java·redis·缓存