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

三.属性注释

/**
* 注释内容
*/

四.方法步骤注释

//注释内容

相关推荐
xqqxqxxq1 小时前
Java AI智能P图工具技术笔记
java·人工智能·笔记
谷雨不太卷1 小时前
进程的状态码
java·前端·算法
顾温1 小时前
default——C#/C++
java·c++·c#
空中海2 小时前
02 ArkTS 语言与工程规范
java·前端·spring
楚国的小隐士2 小时前
在AI时代,如何从0接手一个项目?
java·ai·大模型·编程·ai编程·自闭症·自闭症谱系障碍·神经多样性
yaki_ya2 小时前
yaki-C语言:从概念基础到内存解析---数组(array)完全指南
java·c语言·算法
刃神太酷啦2 小时前
扒透 STL 底层!map/set 如何封装红黑树?迭代器逻辑 + 键值限制全手撕----《Hello C++ Wrold!》(23)--(C/C++)
java·c语言·javascript·数据结构·c++·算法·leetcode
亚历克斯神2 小时前
Java 25 模式匹配增强:让代码更简洁优雅
java·spring·微服务
星辰徐哥2 小时前
Rust异步测试与调试的实践指南
android·java·rust
星河耀银海2 小时前
C++ 运算符重载:自定义类型的运算扩展
android·java·c++