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

三.属性注释

/**
* 注释内容
*/

四.方法步骤注释

//注释内容

相关推荐
青山木1 小时前
Hot 100 --- 岛屿数量
java·数据结构·算法·leetcode·深度优先·广度优先
程序员-珍1 小时前
报错下载android sdk失败
android·java
糖果店的幽灵1 小时前
langgraph分支之 - 动态分支(Dynamic Branch)
java·前端·javascript·人工智能·langgraph
吃饱了得干活1 小时前
亿级订单表分库分表设计,从0到1全流程
java·数据库·面试
唐青枫2 小时前
Java Spring Security 实战详解:从登录认证到 JWT 权限控制
java
曹牧2 小时前
文档格式:OFD
java
豆角焖肉2 小时前
Maven进阶与搭建私服
java·maven
大不点wow3 小时前
Java序列化与反序列化:让对象走出JVM
java·开发语言·jvm
噢,我明白了3 小时前
Java中日期和字符串的处理
java·开发语言·日期
愚公移码3 小时前
蓝凌EKP18产品:整体架构
java·架构·蓝凌