idea 设置类、方法、类属性注释

第一部分:类注释、接口注释

注释生成格式:

/**
 * @Title:  ${NAME}
 * @Description: TODO
 * @author shipj
 * @date ${DATE} ${TIME} 
 * @version 1.0
 */

idea配置注释自动生成配置:

生成样例:

 第二部分:方法生成注释、类属性生成注释

首先创建自定义组,在该组下面创建模版:本文中,MyDefine:自定义组,通过Template Group创建;MyDefine 子项目通过Live Template创建,再对子项进行配置。

方法注释格式:

** 
 * @Author shipj
 * @Description $end$
 $param$
 * @Return $return$
 * @Date $time$ $date$
 */

类属性注释格式:

** 
 * $end$
 */

idea 生成类方法注释配置:

变量 Expression 相关配置:

end:end()

param: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) ? '\\r\\n ' : '')}; return result", methodParameters())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\\b' : '')}; return result", methodParameters()) 

return: methodReturnType()

time:time()

date:date()

 idea 自动生成配置类属性配置:

IDEA 支持使用注释来提供方法的说明,以便更好地理解代码。在 Java 中,可以使用 Javadoc 注释来编写方法注释注释通常位于的声明之前,使用 `/** ... */` 的格式。以下是一个示例: ```java /** * 这是一个示例,用于演示注释的使用。 * 它包含一些属性方法。 */ public class ExampleClass { // 的成员变量 /** * 这是一个示例属性,用于存储数据。 */ private int exampleProperty; // 的构造方法 /** * 这是一个示例构造方法,用于创建 ExampleClass 的实例。 * @param value 初始化属性的值 */ public ExampleClass(int value) { exampleProperty = value; } // 方法 /** * 这是一个示例方法,用于执行某种操作。 * @param parameter 方法的参数 * @return 方法的返回值 */ public int exampleMethod(int parameter) { // 方法的实现 return exampleProperty + parameter; } } ``` 方法注释通常位于方法的声明之前,也使用 `/** ... */` 的格式。在方法注释中,可以描述方法的功能、参数和返回值等信息。以下是一个示例: ```java /** * 这是一个示例,用于演示方法注释的使用。 */ public class ExampleClass { // ... /** * 这是一个示例方法,用于执行某种操作。 * @param parameter1 方法的第一个参数 * @param parameter2 方法的第二个参数 * @return 方法的返回值 * @throws IllegalArgumentException 如果参数无效,则抛出此异常 */ public int exampleMethod(int parameter1, String parameter2) throws IllegalArgumentException { // 方法的实现 if (parameter1 < 0) { throw new IllegalArgumentException("参数 parameter1 必须大于等于 0"); } return parameter1 + Integer.parseInt(parameter2); } } ``` 通过使用注释方法注释,可以提高代码的可读性和可维护性,并且在使用 IDE 时能够更方便地查看代码的说明。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

spjhandsomeman

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值