Intellij IDEA设置类和方法注释(javadoc)

一、设置类的注释

idea中编写java类,class上的注释需要自己手输,不太方便。最近系统崩掉重装,之前用习惯了的注释模板都不见了,索性又去整了一下,做个记录,以防今后有需要的时候可以参考。

设置settings里面的File and Code Templates

在这里插入图片描述

class注释模板粘贴
/**  
* @description: ${todo}
* @author JayXu
* @date ${DATE} ${TIME}
*/
  • 这里的todo会在你创建java文件的时候提示你输入这个类的描述。
效果
/**
 * @author JayXu
 * @description: 租车服务
 * @date 2019/10/23 0023 10:38
 */
public class CarRetal {
}

可以看到这里的时间多出一个0023,这个是显示的当前是本月的第几天,这和windows系统设置有关系。可以在系统时间设置里面设置,如下:(效果待定,设了但是没效果,不知道是不是因为我没重启电脑,因为在下载东西,下次重启再看效果了。)
在这里插入图片描述

  • 如果还是不能去掉这个数字,可以尝试和下面方法注释模板一样的方法来生成一个Live Template.(详见下面的Live Template设置)

二、设置方法的注释模板

设置settings里面的Live Templates
  • 这张图的步骤是正确的,但是没效果,正确配置继续往下看。
    在这里插入图片描述
方法注释模板粘贴
**
* @description: $description$
* @param $param$
* @return $return$
* @throws 
* @author JayXu
* @date $date$ $time$
*/

注意:这边的模板开头的斜杠去掉!

  • 适用范围选择自己想要的范围
  • 编辑公式
    在这里插入图片描述
  • 设置完成后默认是输入/*(我这设置了 * 为缩写,忽略上面的图),按enter键触发。效果如下:
    在这里插入图片描述
    完!
  • 1
    点赞
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
IntelliJ IDEA 是一款强大的 Java 开发集成环境,它提供了丰富的代码自动生成和模板设置功能,其中注释模板是帮助开发者快速生成常见注释的一种便捷方式。以下是设置注释模板的基本步骤: 1. **打开注释模板设置**: 在 IntelliJ IDEA 中,点击 "File"(在 macOS 上是 "IntelliJ IDEA" 或者 "Code"),然后选择 "Settings"(Windows 和 Linux)或 "Preferences"(macOS)。 2. **导航至 "Code Style"**: 在设置窗口中,找到并展开 "Editor" > "Code Style" > "Java"。 3. **选择 "Live Templates"**: 在 Java 配置区域,你会看到 "Live Templates",这是管理模板的地方。 4. **创建或编辑模板**: 右键点击 "Code" 或 "Comment" 栏目下的空白区域,选择 "Edit" 来添加新的注释模板。例如,你可以为 Javadoc 注释创建一个模板,键入 `javadoc` 作为前缀,然后输入你的模板内容,比如: ``` /** * ${cursor}${description} * * @param ${param} 参数描述 * @return 返回值描述 * @throws ${exception} 可能抛出的异常 */ ``` 这里 `${cursor}` 表示光标插入的位置,`${description}`、`${param}` 和 `${exception}` 是占位符,会在输入时自动替换为你指定的内容。 5. **保存模板**: 完成模板配置后,记得点击 "OK" 保存你的更改。 6. **使用模板**: 在编写代码时,只需输入模板前缀(如 `javadoc`),然后按相应的快捷键(通常是 `Ctrl + Alt + T` 或者 `Cmd + Alt + T`),即可根据模板快速生成注释
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值