【注释模板】IDEA中JAVA类、方法注释模板教程

这篇具有很好参考价值的文章主要介绍了【注释模板】IDEA中JAVA类、方法注释模板教程。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

1.引言

都说好的开始是成功的一半,而类比到程序开发中,好的注释无疑是项目成功的基石,良好的注释编程规范不仅可以使后续的测试、维护人员更好地理解开发者思想,提高代码可读性,保证迭代效率;还可以在编写注释时思考验证自己的编码逻辑是否严谨、经得住推敲。由此可见,养成勤写注释,写好注释的习惯是合格程序员的一门必修课。

为了方便、系统化IDEA开发者对于创建JAVA类、方法等注释的编写,今天为读者们介绍如何设置并利用模板实现高效开发,快速迭代。

2.JAVA创建类时注释模板配置

2.1 打开IDEA,依次点击File–>Setting

idea java注释模板,java,intellij-idea,ide

2.2 在Settings界面中依次点击Editor–>File and Code Templates,并在Files中选择Class模板

idea java注释模板,java,intellij-idea,ide

2.3 将模板代码贴入Class模板中,勾选Enable Live Templates,最后保存设置

idea java注释模板,java,intellij-idea,ide

/**
 * @Author:     YourName
 * @Date:       ${DATE} ${HOUR}:${MINUTE}
 * @Description: 
 **/

2.4 创建名为Test的JAVA文件,查看创建类模板设置后的效果

idea java注释模板,java,intellij-idea,ide

3.代码编写中注释模板配置

3.1 类注释的配置

3.1.1 在IDEA主界面依次点击File–>Setting

idea java注释模板,java,intellij-idea,ide

3.1.2 在Settings界面中依次点击Editor–>Live Templates

idea java注释模板,java,intellij-idea,ide

3.1.3 点击上一步界面中右上角"+"中的Template Group,创建名为"userDefine"的Group

idea java注释模板,java,intellij-idea,ide

idea java注释模板,java,intellij-idea,ide

3.1.4 选中刚刚创建的"userDefine"Group,点击右上角"+"中的Live Template

idea java注释模板,java,intellij-idea,ide

3.1.5 配置当前模板

给当前模板取别名,写备注

idea java注释模板,java,intellij-idea,ide

粘贴以下代码到Template text中

*
 * @ClassName $classN$
 * @Author Vincent
 * @Description 
 * @Date $date$ $time$
 **/

配置 Template text中的变量,下拉选择

idea java注释模板,java,intellij-idea,ide

设置该模板的作用域

idea java注释模板,java,intellij-idea,ide
idea java注释模板,java,intellij-idea,ide

设置模板触发的快捷键

idea java注释模板,java,intellij-idea,ide

3.1.6 保存配置,在Test.java文件中测试触发后效果

触发规则:在类名前依次键入 /*+ 别名+TAB(键盘上的)
我的类模板别名为c,因此我的触发规则为/*cTAB

idea java注释模板,java,intellij-idea,ide

3.2 方法注释的配置

前置步骤与3.1相同,唯比类的注释多了几个参数,进行相应的参数配置即可

idea java注释模板,java,intellij-idea,ide
idea java注释模板,java,intellij-idea,ide

idea java注释模板,java,intellij-idea,ide

4.总结

在编程世界中,不断学习新技术和更新自己的知识是至关重要的。作为一名开发者,我们必须紧跟时代潮流,适应快速变化的技术发展,才能保持竞争优势并创造出更好的产品和服务。同时,我们也需要将所学到的知识分享给其他开发者,以促进整个行业的发展。编程技术分享不仅可以提高我们自身的技能水平,还可以帮助其他人解决问题和学习新技术。因此,我希望大家能够积极参与技术社区,分享自己的经验和见解,在交流中不断成长和提升。让我们一起为编程行业的未来做出贡献!文章来源地址https://www.toymoban.com/news/detail-741174.html

到了这里,关于【注释模板】IDEA中JAVA类、方法注释模板教程的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

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

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

相关文章

  • IDEA类和方法注释模板设置

        IDEA自带的注释模板不是太好用,我本人在网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家。本人亲测可用,自己配置过 1、File--settings--Editor--File and Code Templates--Files 我们选择Class文件、interface、Enum这三个地方 (1)${NAME}:设置类名,与下面

    2024年02月07日
    浏览(64)
  • idea 自定义类注释模板和方法模板,无警告

       注意,空了一行,完全复制: param return 格式化有问题,可以研究一下语法解决一下,弄完需要格式化

    2024年02月16日
    浏览(48)
  • IDEA 配置注释模板

    目录 一、配置类模板注释 二、配置方法注释 打开IDEA,打开 settings ( 快捷键:Ctrl + Alt + s) ,选择 Editor ,找到 File and Code Templates ,设置需要配置注释的文件类型,如下图所示: 选择需要配置注释的文件,填入以下内容:  其他文件类似,按需修改 @ClassName 为 @InterfaceName 或者

    2024年02月11日
    浏览(45)
  • idea如何设置注释模板,图文超详细讲解

    目录 先打开idea设置 一,idea类注释 1,找到以下设置 2,设置模板 3,apply保存完成 二,idea方法注释 1,创建自定义的组 2,创建模板 3,设置模板 4,选择生成模板的文件 5,绑定选择参数 6,完成ok 类注释模板和接口注释模板 方法注释模板 生成模板 /** +模板名+快捷键, 选择

    2024年02月14日
    浏览(48)
  • IDEA个性化设置注释模板(详细版)

    类注释模板 方法注释模板 效果展示 类注释模板是IDEA创建类时生成的注释 第一步、File - Settings 第二步、Editor - File and Code Templates - Includes - File Header 点apply,再点ok即可 模板参考如下: 按照 /**+Enter 来设置IDEA的方法注释 步骤 第一步、File - Settings 第二步、选择“Editor”-“L

    2024年02月03日
    浏览(57)
  • IDEA创建Java类时自动配置注释(作者,创建时间,版本等)

    在使用IDEA创建Java类时,自动配置注释功能可以通过以下步骤启用: 打开IDEA的设置窗口。 选择“Editor”选项卡,然后选择“File and Code Templates”。 在“File and Code Templates”窗口中,选择“Includes”选项卡。 在“Includes”选项卡中,选择“File Header”并编辑以下内容: 单击“

    2024年02月16日
    浏览(48)
  • IDEA2022版教程上(下载、卸载、安装、新建Project、jdk设置、详细设置、新建/导入/删除普通java模块、修改模块名、同时打开多个工程、常用代码模板:非空判断,遍历,输出语句快捷键)

    初学Java语言,熟悉了记事本、EditPlus、NotePad++或Sublime Text3等简易开发工具的Java初学者 熟练使用其他Java集成开发环境(IDE),需要转向IDEA工具的Java工程师们 关注IDEA各方面特性的Java程序发烧友、爱好者 【注】JetBrains官方说明: 尽管我们采取了多种措施确保受访者的代表性

    2024年02月07日
    浏览(69)
  • Intellij-idea 如何编译maven工程*

    在 Intellij IDEA 中编译 Maven 工程的步骤如下: 打开你的 Maven 工程。如果工程已经在 IDEA 中打开,那么你可以直接进行下一步。如果没有,你可以通过 File - Open 在弹出的对话框中选择你的 Maven 工程路径进行打开。 打开 Maven 项目窗口。在 IDEA 的右边会有一个 Maven 项目的窗口,

    2024年02月02日
    浏览(70)
  • Linux 创建 intellij-idea快捷方式

    在 Linux 中,可以通过创建快捷方式的方式方便地打开 IntelliJ IDEA 开发工具。下面是创建 IntelliJ IDEA 快捷方式的详细步骤: 第1步:打开终端窗口 首先,要打开终端窗口。可以通过快捷键 Ctrl + Alt + T 打开终端窗口。也可以在系统菜单栏中选择“应用程序”-“实用工具”-“终端

    2024年02月03日
    浏览(78)
  • Intellij-idea 如何编译maven工程

    在 IntelliJ IDEA 中编译 Maven 工程是一个相对直接的过程。以下是基本步骤: 1. 打开或导入 Maven 项目 如果您已经有一个现有的 Maven 项目,可以直接在 IntelliJ IDEA 中打开它。选择 File Open,然后浏览到您的 Maven 项目文件夹,选择包含 pom.xml 的目录。 如果您是从现有的源代码导入

    2024年01月25日
    浏览(73)

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

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

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

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

二维码1

领取红包

二维码2

领红包