IntelliJ IDEA 如何优雅的添加文档注释(附详细图解)

这篇具有很好参考价值的文章主要介绍了IntelliJ IDEA 如何优雅的添加文档注释(附详细图解)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

📌提要


在开发过程中,最常用的注释有两种:类注释方法注释,分别是为类和方法添加作者、日期、版本号、描述等一系列信息,增强代码的可读性,保证代码的可维护性,但通常一个项目中有数不清的类和方法,手动添加未免过于繁杂,如何有效、便捷地添加注释呢?

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

✍✍类注释


✨类注释可以通过修改文件和代码模板实现,在新建文件时自动添加类注释,具体实现效果如下:

1.打开IntelliJ IDEA,依次点击File > Settings > Editor > File and Code Templates > Files,可以看到各类文件的新建默认格式模板

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

2.此处以class文件为例,在右侧编辑栏中直接根据需要进行添加(注意不要把原本信息覆盖),笔者模板如下:

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

/**
 * @Author:     Insight
 * @Description:  TODO  
 * @Date:    ${DATE} ${TIME}
 * @Version:    1.0
 */ 

注:
1️⃣其它类型的文件可根据自己的需要进行修改。
2️⃣${} 中的值代表变量,支持的变量如下:

变量名 含义
${PACKAGE_NAME} 当前新建文件的包名
${NAME} 新建文件时指定的文件名
${USER} 当前登录用户昵称
${DATE} 当前系统日期
${TIME} 当前系统时间
${YEAR} 当前系统年份
${MONTH} 当前系统月份
${MONTH_NAME_SHORT} 当前系统月份缩写(Jan、Feb…)
${MONTH_NAME_FULL} 当前系统月份全拼 (January, February…)
${DAY} 当前系统日份
${HOUR} 当前系统时间(时)
${MINUTE} 当前系统时间(分)
${PROJECT_NAME} 项目名称

3.如果想要一次性为所有文件全部应用模板,切换到FIles右侧的Includes,可以看到File Header,在其中添加注释模板即可

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

4.在项目中新建文件即可自动添加注释

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

✍✍方法注释


方法注释没有系统模板的支持,无法自动添加,但可以通过自定义用户模板进行快捷添加

1.打开IntelliJ IDEA,依次点击File > Settings > Editor > Live Templates,点击右上角 + ,选择Live Template,创建一个用户自定义模板

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

2.根据需要填写Abbreviation(后续的引用需要使用)、Description(选填)、Text(可参考下方模板)

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

笔者方法注释模板
注:对于变量使用"$$"包裹

*
 * @Author Insight
 * @Date $date$ $time$
 * @Description This is description of method
 * @Param $param$
 * @Return $return$
 * @Since version 1.0
 */

3.对模板中的变量赋值,保证变量的动态修改

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

4.修改方法注释作用域为所有Java文件

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库

5.在.java文件中输入/*m(m为注释缩写),点击tab,方法注释自动生成

IntelliJ IDEA 如何优雅的添加文档注释(附详细图解),intellij-idea,java,数据库


💕至此,我们就可以优雅地添加注释了!创作不易,点个赞吧~文章来源地址https://www.toymoban.com/news/detail-640266.html

到了这里,关于IntelliJ IDEA 如何优雅的添加文档注释(附详细图解)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • IDEA优雅自动生成类注释和快捷键生成方法注释

    Preferences - Editor - File and Code Templates - Includes - File Header 注释模板: 查看IDEA自动配置java快捷键 Preferences - Editor - Live Template - java 手动新增添加Group 描述:如下图,我手动添加了 MyGroup 分组 字段注释 操作步骤如下 添加 Live Template 添加 Abbreviation (快捷键)和 Description (描述)

    2024年02月06日
    浏览(69)
  • IDEA如何运行Eclipse项目(超详细图解)

    大家好✌!我是Dwzun。很高兴你能来阅读我,我会陆续更新Java、前端、数据库、项目案例等相关知识点总结,还为大家分享优质的实战项目,本人在Java项目开发领域有多年的经验,陆续会更新更多优质的Java实战项目,希望你能有所收获,少走一些弯路,向着优秀程序员前行

    2024年02月02日
    浏览(57)
  • IDEA如何运行SSM项目(超详细图解)

    大家好✌!我是Dwzun。很高兴你能来阅读我,我会陆续更新Java、前端、数据库、项目案例等相关知识点总结,还为大家分享优质的实战项目,本人在Java项目开发领域有多年的经验,陆续会更新更多优质的Java实战项目,希望你能有所收获,少走一些弯路,向着优秀程序员前行

    2024年01月16日
    浏览(52)
  • IDEA如何运行SpringBoot项目(超详细图解)

    📖本篇超级详细案例截图教学 IDEA如何运行Springboot项目,图片点击可放大仔细看 项目里面一般会包含项目源码、数据库、环境配置教程、运行教程。 项目介绍文件有的是.md文件,这个需要记事本或者typora打开,word打开是乱码。 打开运行教程每个项目都有运行环境的介绍、

    2024年02月03日
    浏览(57)
  • IntelliJ IDEA修改背景颜色大全(护眼绿等)设置注释颜色

    一.IDEA默认有3种背景颜色 路径为File-settings-Editor-Color Scheme可以设置软件默认颜色,旁边的小齿轮添加颜色名字 第一种方法: IDEA设置一张背景图片,路径:File-Settings-AppearanceBehavior-Appearance 第二种方法: 手动设置护眼绿的RGB颜色 路径:File-Settings-Editor-Color Scheme-General  到这里

    2024年02月13日
    浏览(59)
  • 最新 IntelliJ IDEA 旗舰版和社区版下载安装教程(图解)

    🌷🍁 博主猫头虎(🐅🐾)带您 Go to New World✨🍁 🦄 博客首页 ——🐅🐾猫头虎的博客🎐 🐳 《面试题大全专栏》 🦕 文章图文并茂🦖生动形象🐅简单易学!欢迎大家来踩踩~🌺 🌊 《IDEA开发秘籍专栏》 🐾 学会IDEA常用操作,工作效率翻倍~💐 🌊 《100天精通Golang(基础

    2024年02月06日
    浏览(86)
  • IntelliJ IDEA2023旗舰版和社区版下载安装教程(图解)

    博主猫头虎的技术世界 🌟 欢迎来到猫头虎的博客 — 探索技术的无限可能! 专栏链接 : 🔗 精选专栏 : 《面试题大全》 — 面试准备的宝典! 《IDEA开发秘籍》 — 提升你的IDEA技能! 《100天精通Golang》 — Go语言学习之旅! 领域矩阵 : 🌐 猫头虎技术领域矩阵 : 深入探索

    2024年02月05日
    浏览(49)
  • IDEA中设置文档注释(详解)

    File–Settings–Editor–File and Code Templates–Includes 我的模板如下:(仅供参考) File–Settings–Editor– Live Templates 2.1、先到这一步↑↑↑↑↑↑↑ 2.2、然后加下来的要按顺序来: 2.3、创建一个分组(名字自己随便命名) 2.4、创建一个子文件 2.5、接下来就是严格按照步骤操作:

    2024年02月04日
    浏览(39)
  • 在IntelliJ IDEA IDE中添加jar包的步骤

    在IntelliJ IDEA IDE中添加jar包的步骤如下: 打开IntelliJ IDEA,打开需要添加jar包的项目。 在IntelliJ IDEA右侧的项目导航器中,找到项目。 右键单击项目,选择\\\"Open Module Settings\\\"(也可以使用快捷键F4)。 在弹出的\\\"Project Structure\\\"窗口中,选择\\\"Modules\\\"。 在\\\"Modules\\\"选项卡中,选择模块。

    2024年02月06日
    浏览(41)
  • IntelliJ IDEA 中使用Apifox IDEA 插件快速生成接口API (Java 开发告别写接口文档)

    Apifox IDEA 插件快速上手 | Apifox 帮助文档 特别注意: 1、idea版本必须大于2019.03才可以使用这个插件 2、修改设置不然分组校验必填项,apifox里面显示都是必填 添加图片注释,不超过 140 字(可选) Apifox IDEA 插件(Apifox Helper) 主要用于 IDEA 项目快速生成 API 文档,并同步到 A

    2024年03月24日
    浏览(66)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包