IDEA自动注释

1、自动注释class

打开Settings——>Editor——>File and Code Templates——>class,添加如下代码

   /**  
    * ${description}
    * @author ${USER}
    * @date ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}:${SECOND}
    */

2、自动注释方法

1)、打开Settings——>Editor——>Live Templates——>点右侧+号Template Group——>选中新增的group点右侧+号Live Template填写如下代码

*
 * $end$ 
 * @date $date$ $time$
 * @author $user$
 $param$
 * @return: $returns$
 */        

2)、点击Edit Variables,填写变量

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

3)、Expand with选择Tab,abbreviation一栏填写*

4)、在方法名上方输入/**,点击tab键生成注释

### 设置自定义注释模板 在 IntelliJ IDEA 中设置自定义注释模板的过程涉及多个方面,包括但不限于欢迎信息、类或方法注释模板以及配置生成注释的方式。 为了实现这一目标,在 IntelliJ IDEA 的设置界面中找到 `Editor` -> `File and Code Templates` 路径下的 `Includes` 选项卡可以进行全局性的注释片段定制[^1]。对于更具体的场景,如针对每一个新创建的 Java 类或是函数添加特定格式的头部说明,则需前往 `Live Templates` 下新建相应的 live template 条目,并利用 `${USER}` 和 `${DATE}` 这样的预设变量来动态填充作者姓名和日期等信息[^2]。 #### 定义类注释模板实例 当希望每次创建新的 Java 文件时都能自动附带一段标准格式化的描述性注释,可以在上述提到的 Live Template 功能里加入如下所示的内容: ```java /** * @ClassName: ${NAME} * @Description: TODO(在此处填写该类的功能简介) * @Author: ${USER} * @Date: ${DATE} */ ``` 这段代码展示了如何构建一个简单的类级注释结构,其中包含了类名称、功能概述字段(待开发者补充)、作者身份标记及编写时间戳记四个部分[^3]。 #### 方法级别的注释模板设定 同样的逻辑也适用于为各个成员函数配备个性化的前置文档字符串。通过相似的方法注册一个新的 live template 并指定触发条件后,即可让 IDE 在适当的时候提示输入以下形式的方法头注解: ```java /** * @param 参数列表解释 * @return 返回值含义阐述 */ public void methodName() { // method body... } ``` 值得注意的是,为了让用户能够更加便捷地调用这些预先设计好的模板,建议调整 "Expand with:" 字段后的热键绑定至 Enter 键上,从而简化实际开发过程中的操作流程[^5]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值