IntelliJ IDEA的类注释和方法注释

效果图如下:
类注释:
在这里插入图片描述
方法注释:
在这里插入图片描述

idea不会默认帮我们设置,所以需要手动设置。

1:IDEA中在创建类时会自动给添加注释

打开idea,操作
File–>settings–>Editor–>File and Code Templates–>Files
(1) N A M E : 设 置 类 名 , 与 下 面 的 {NAME}:设置类名,与下面的 NAME{NAME}一样才能获取到创建的类名

(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述

(3) U S E R 、 {USER}、 USER{DATE}、 T I M E : 设 置 创 建 类 的 用 户 、 创 建 的 日 期 和 时 间 , 这 些 事 I D E A 内 置 的 方 法 , 还 有 一 些 其 他 的 方 法 在 红 色 框 标 注 的 位 置 , 比 如 你 想 添 加 项 目 名 则 可 以 使 用 {TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在红色框标注的位置,比如你想添加项目名则可以使用 TIMEIDEA使{PROJECT_NAME}
在这里插入图片描述

2.在方法的上面一行输入/*然后回车,就有方法的注释设置如下

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是

/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

1、File–>Settings–>Editor–>Live Templates
在这里插入图片描述
(1)新建组:命名为userDefine
在这里插入图片描述
(2)选中userDefine在其目录下新建模板:命名为*

因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为

/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()

(3)设置生成注释的快捷键
在这里插入图片描述
(4)设置模板:模板内容如下
注意第一行,只有一个而不是/

在设置参数名时必须用 参 数 名 {参数名} 的方式,否则第五步中读取不到你设置的参数名


*
 * @Author 小思
 * @Description //TODO 
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

(5)设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可(如果曾经修改过,则显示为change而不是define)

在这里插入图片描述
在这里插入图片描述
(6)设置参数的获取方式
在这里插入图片描述
在这里插入图片描述
依次下拉选择即可。
注意第五步和第六步的顺序不可颠倒哦~

说在最后的话:编写实属不易,若喜欢或者对你有帮助记得点赞+关注或者收藏哦~

  • 66
    点赞
  • 123
    收藏
    觉得还不错? 一键收藏
  • 13
    评论
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`),即可根据模板快速生成注释
评论 13
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值