文档注释的使用,导出Java项目的API文档

本文介绍如何在IntelliJ IDEA中自定义文档注释模板,包括文件头注释及方法注释的设置步骤,帮助提高代码注释效率。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

先了解一下idea自定义文档注释模板
IntelliJ IDE --> Preferences --> Editor --> File and Code Templates --> Includes --> File Header


/**
* ClassName: ${NAME} <br/>
* Description: <br/>
* date: ${DATE} ${TIME}<br/>
* @author ${USER}<br/>
* @version
* @since JDK 1.8
*/

2 方法注释
IntelliJ IDE --> Preferences --> Setting --> Editor --> LiveTemplates

  1. 绿色的+号,选择Template Group双击 新建的Template Group eg:MyGroup

  2. 选择MyGroup,再次点击右面的加号,选择第一个选项 live Template
    注意:addrebiation :快捷键

  3. 设置change 选中 java相关(否则快捷键无效)
    复制代码

/**

  • Description:
  • @author: USERUSERUSER
  • @date: DATEDATEDATE TIMETIMETIME
  • @param:paramparamparam
  • @return:returnreturnreturn
    */

复制代码

变量定义

user --> user()
date–>date()
time–>time()
param–>methodParameters()
return–>methodReturnType()

生成文档:
在这里插入图片描述在这里插入图片描述记得在 Other Command line arguments:出填写 -encoding utf-8 -charset utf-8否则会出现乱码
这样就生成了api了
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值