idea添加类和方法注释

一.类注释

1.点击右上角intelliJ IDEA下
2.点击preferences-editor
3.点击Editor
4.选择File and Code Templates
5.在右边Files中选中class
在这里插入图片描述

注释生成规则如下

/**
* @description: ${description}
* @program: ${PROJECT_NAME}
* @author: name
* @date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

二.方法注释

1.点击右上角intelliJ IDEA下
2.点击preferences-editor
3.点击Editor
4.选择LiveTemplates
5.点击右边的绿色加号
6.点击Template Group选择加一个分组,比如My Group
在这里插入图片描述
7.选择刚才建的分组,再次点击右边加号点击Live Template
在这里插入图片描述

Abbreviation是选择的快捷键,Description是快捷键名
注释生成规则如下

    /** 
 * @description: $description$ 
 * @param $params$ 
 * @return: $returns$ 
 */

8.添加完上面的之后,点击右边的Edit varibles:
在这里插入图片描述
9.添加完上面的之后,点击ok然后点击Apply就可以应用了,快捷键为 q+Tab

但是这个方式不能读取方法里面的参数,
可以将注释生成规则改为如下:

在这里插入图片描述
/**+Tab 生成注释 但是这样的话读取的第一个参数会出现警告
或者直接用默认的注释,快捷键为/**+Enter

### 如何在 IntelliJ IDEA 中正确添加注释方法注释 #### 添加注释 为了在 IntelliJ IDEA 中自动生成并编辑注释,需访问设置页面。具体操作是在IDEA中打开`File-Settings`,随后定位到`Editor-File and Code Templates`位置,在左侧菜单选择`Files`下的`Class`选项[^1]。 一旦在此处进行了配置,每当新建一个文件时,所设定的模板将会被应用,从而自动加入预定义好的注释[^3]。例如: ```java /** * @author xc * @description TODO 描述这个的功能 * @create 2023-02-27 09:19 */ public class Test3 { } ``` 上述代码片段展示了如何通过模板生成带有作者、描述以及创建日期的标准注释格式[^5]。 #### 编写方法注释 对于方法级别的注释,通常建议手动编写以确保其准确性与详尽程度。然而,也可以利用特定占位符来辅助完成此过程。比如`${THROWS_DOC}`可以用于表示可能抛出的异常列表;如果目标函数确实存在异常处理逻辑,则会相应地填充这些信息,反之则保持空白[^4]。 下面是一个完整的方法注释实例: ```java /** * 计算两个整数之. * * @param a 第一个加数 * @param b 第二个加数 * @return 返回两数相加之 * @throws ArithmeticException 如果发生除零错误或其他运算溢出情况 */ private int add(int a, int b) throws ArithmeticException { return a + b; } ``` 在这个例子中,包含了参数说明(`@param`)、返回值解释(`@return`)以及潜在异常声明(`@throws`)等内容,这些都是构成良好实践的一部分。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值