IDEA 新建类时自动生成 Javadoc 注释(描述、作者、日期)

在新建一个类的时候经常忘了写Javadoc,于是可以利用IDEA工具,进行自动生成标准的模板注释,方便后期维护。

步骤:

1、打开:File -> Setting ,弹出"Setting对话框"

2、找到  Editor -> File and Code Templates -> Files -> Class 

3、在  “public class ${NAME} {  ”  这一行之前加入以下代码 ( 可自己定义)


/**
* <h3>${PROJECT_NAME}</h3>
* <p>${description}</p>
* @author : 你的名字
* @date : ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

 

设置如图:

### 配置 IntelliJ IDEA 自动生成 JavaDoc 注释 #### 注释配置 为了使 IntelliJ IDEA创建自动添加带有特定标签(如 `@author` 和 `@date`)的 JavaDoc 注释,需进入设置页面调整相应的选项。具体路径为 Settings => Editor => File and Code Templates[^2]。 在此处可编辑 Class 文件模板,在其中加入期望自动生成的内容框架,比如: ```java /** * @author ${USER} * @date ${DATE} ${TIME} */ public class ${NAME} { // ... } ``` 这样每当新建一个 Java 文件的候就会按照上述格式填充基本信息。 #### 方法注释配置 对于方法级别的文档字符串,默认情况下 IDE 已经能够很好地处理参数、返回值以及可能抛出异常的信息生成工作。然而为了让其更加完善,同样可以通过修改 Inspection 设置来增强功能。前往 Settings => Editor => Inspections, 查找 "Declaration has Javadoc problems" 检查项下的 Options 子菜单,并通过 Add javadoc tags 来指定额外想要包含在内的元数据字段[^3]。 另外一种简便的方式是在编写代码过程中直接利用快捷键组合 `/ ** /` 或者按下 Alt + Enter 组合键选择 “Generate documentation comment”,这将立即为你当前正在输入的方法签名上方插入标准形式的多行注释结构[^4]。 例如: ```java /** * 利用 dfs (递归实现) * @param root 根节点对象 * @return 是否满足条件的结果布尔值 */ public boolean evaluateTree(TreeNode root) {} ```
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值