IDEA类和方法注释模板设置

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

一、概述

    IDEA自带的注释模板不是太好用,我本人在网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家。本人亲测可用,自己配置过

二、类、接口、枚举类注释模板

1、File-->settings-->Editor-->File and Code Templates-->Files

我们选择Class文件、interface、Enum这三个地方

(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

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

(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

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

2、效果图展示:

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

 这里我创建的是类,若果创建的是接口和枚举类,同样也会有这个注释模版

注释模版

/**
 *@ClassName ${NAME}
 *@Description  TODO
 *@Author houbing
 *@Date ${DATE} ${TIME}
 */

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

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

1、File-->Settings-->Editor-->Live Templates
idea类注释模板,intellij-idea,java,ide

新建组:命名为myGroup

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

然后再点击下面这个按钮idea类注释模板,intellij-idea,java,ide 就会生成下面这种图

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

第一个空填 * 第二个空填 方法注释

然后在Template text这里面填上

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

*
 * @Description //TODO $end$
 * @Date $date$ $time$ $param$ $return$
**/

 之后点击这个按钮

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

点击完成后,并进行配置里面的值,配置完成之后,就成下图这样

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

date配置date()这个值

param这里配置的值如下:

groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())

return这里配置的值如下:

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

都配置完成之后点击ok,接下来Expand with这个地方,改为Enter这个选项

之后,在按照下图的配置,点击Define之后,选择Java这个选项,到这里就算配置完成

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

 如果之前这里进行配置了,可以点击下面这个按钮进行修改选择项

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

 到这里就已经配置完方法的注释模版,我们一起来验证之后

在方法上面敲 “ /** ” ,然后进行回车,就会生成如下:

idea类注释模板,intellij-idea,java,ide文章来源地址https://www.toymoban.com/news/detail-729208.html

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

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

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

相关文章

  • Intellij-idea 如何编译maven工程*

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

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

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

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

    在 IntelliJ IDEA 中编译 Maven 工程,你需要遵循以下步骤: 打开 IntelliJ IDEA :首先,启动 IntelliJ IDEA。 打开 Maven 项目 :在欢迎界面上,选择 \\\"Get from Version Control\\\",然后选择你的 Maven 项目的仓库地址。或者,如果你已经有了项目文件(如  .idea  和  pom.xml ),你可以直接打开这

    2024年01月18日
    浏览(85)
  • Java开发+Intellij-idea+Maven+工程构建

    Intellij-idea是一款流行的Java集成开发环境,它支持Maven作为项目管理和构建工具。Maven可以帮助开发者自动下载项目依赖的jar包,执行编译、测试、打包等生命周期任务。本资源将介绍如何在Intellij-idea中创建、导入、转换和编译Maven工程,以及如何配置Maven的相关参数和插件。

    2024年02月01日
    浏览(106)
  • idea配置Idea类注释模板和方法注释模板(亲测有效)

    网上找了很多都不理想,要不就是params为null,取不到值,要不就是格式模板不理想,今天自己整理去做了一下,记录今天操作 1.选择File–Settings–Editor–File and Code Templates进入到下图位置分别设置Class/interface/Enum文件  类模板 2.设置方法注解快捷键等模板 选择File–Settings–

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

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

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

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

    2024年02月14日
    浏览(46)
  • 【注释模板】IDEA中JAVA类、方法注释模板教程

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

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

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

    2024年02月16日
    浏览(44)
  • IDEA工具第二篇:自定义Java方法注释模板

    网上搜索类似的文章有很多,但是一味的复制粘贴总会出现各种奇葩问题,最后然并卵!今天特意自己研究琢磨一下,将最终结果分享给大家,100%亲测可用。 想必大家都用过 Eclipse 的方法注释生成,方法上输入 /** ,回车走你,巴拉巴拉如下的注释便生成了,今天就悄悄告诉

    2024年02月08日
    浏览(59)

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

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

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

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

二维码1

领取红包

二维码2

领红包