IDEA中对类和方法注释模板的设置 (保姆级教程)

1. 类注释模板

1.1 产生问题:

  • 主要用在创建一个新类时, 自动添加上的一些默认的信息, 比如类名, 作者名, 类的创建时间, 版本号等等, 这些设置好模板就不需要再一个个手动添加了.

1.2 解决问题

  • 点击左上角File → 找到settings打开 → Editor → File and Code Templates → Files → class
  • 这里主要说一下创建类(class) 时自动生成的一些数据:
    • @className: ${NAME}:设置类名,要与下面的${NAME}一样才, 能获取到创建的类名.
    • @author: LXHYouth是作者的名字, 这里可以写死, 也可以使用 ${USER} 获取电脑登录的用户名.
    • @date: ${DATE} ${TIME}获取创建类的时的时间
    • @Version: 1.0 版本号, 可以写死, 毕竟新创建的版本都是第一版嘛.
    • @description:预留出来可以写一些描述的语句.
    • 直接复制过去就好了, 但是不要修改之前就已有的代码
/**
 * @className: ${NAME}
 * @author: LXHYouth
 * @date: ${DATE} ${TIME}
 * @Version: 1.0
 * @description:
 */   
  • 重点提一下: 复制过去的代码一定要在类的上面. 不然就会出现很尴尬的事情.
  • 比如这样:alt text

2. 方法注释模板

2.1 为方法设置注释模板

  • IDEA目前还没有支持自动添加方法注释, 那就要自己手动写好添加一下.
  • 位置: File → Settings → Editor → Live Templates
  • 点击右侧的 + 先创建一个一个分组: 可以先命名为 userDefine
  • 找到刚刚创建的 userDefine 分组, 点击一下, 然后点击 + 号创建一个模板.
  • alt text
  • 由于IDEA默认生注释的方式为: /*加Tab, 那我们就可以延用一下, 可以把模板缩写(Abbreviation)填 * , 当然如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType(), Description: 是模板的解释说明. Template text: 需要注释的模板内容. 可以直接复制过去.
  • Abbreviation: *
  • Description: Add Comments for method.
  • Template text:
    *
    * @Author LXHYouth
    * @Description 
    * @Date $time$ $date$
    * @Param $param$
    * @return $return$
    **/
    
  • 设置一下应用场景, 由于我是用Java语言编写代码, 那么范围直接选Java就可以了. 没设置过的是 Define (如果修改过的就是change) , 点击一下选择Everything → Java
  • 现在设置一下参数, 选择右侧的Edit variables按钮
    注意:一定要按顺序来, 不可颠倒,不然这里就获取不到方法
  • 可以按如下设置:
  • 保存一下 Apply → OK
  • 现在去测试一下效果, 嗯!!! 非常成功.

2.2 快捷添加基本信息

  • 使用场景: 比如拿到一个代码文件, 要填加自己的一下基本注释信息, 我们也可以使用刚刚的方法添加一下.

  • 使用刚刚的操作(这里就不复述了), 创建一个LXHYouth_Information分组, 你们可以按着自己的修改.

  • Abbreviation: l

  • Description: Basic user information.

  • Template text:

    /**
    * @author: LXHYouth
    * @date: $date$ $time$
    * @Version:    1.0
    * @Description
    **/
    
  • 这里我把模板缩写(Abbreviation)填小写的 l , 就是我名字的第一个开始的字母 (这么设置就是为了速度快), 然后按之前步骤一次填入和设置. 最后保存一下.

  • 测试一波: 快速添加个人基本信息. 比如刚刚老师下发的作业题, 在package包代码下行添加自己的基本信息, 直接输入一个 l 加 Tab键就添加成功了.


  • 到此教程就结束了.

  • 转载: 请附上本文链接.

  • 如果文章对你有帮助, 可以点赞收藏一下, 以防下次需要可以快速找到.

  • 22
    点赞
  • 24
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
在IntelliJ IDEA设置方法注释模板可以按照以下步骤进行操作: 1. 首先,点击菜单栏的 "File",然后选择 "Settings"。 2. 在弹出的窗口,选择 "Editor" -> "Live Templates"。 3. 在右侧的面板,点击 "+" 图标,然后选择 "Template Group..." 来添加一个新的组。 4. 给这个新的组命名。 5. 再次点击 "+" 图标,选择 "Live Template" 来添加一个新的模板。 6. 配置注释模板,可以设置一个缩写,比如 "/**",然后在方法的上方输入 "/**",按下补全键(默认是 Tab 键)就可以按照你设置的模板生成注释了。 7. 对新建模板进行描述,设置注释模板的内容。 8. 可以选择设置补全键,默认是 Tab 键,你也可以设置为 Enter 键。 9. 设置注释模板后,记得启用 "Enable Live Templates",这样在创建新的文件时才会自动生成你设置的模板注释。 这样,你就可以方便地设置和使用idea方法注释模板了。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *3* [idea注释模板设置(史上最全!!!)](https://blog.csdn.net/AwesomeJokerWang/article/details/117784282)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* [IDEA设置方法注释模板](https://blog.csdn.net/engerla/article/details/119254597)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值