idea文档注释设置_eclipse添加方法注释模板

idea文档注释设置_eclipse添加方法注释模板IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:类注释模板:…

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE稳定放心使用

一、概述

    IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。

这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:

类注释模板:                                                                      方法注释模板:

idea文档注释设置_eclipse添加方法注释模板    idea文档注释设置_eclipse添加方法注释模板

二、类注释模板

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

我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)

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

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

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

(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

idea文档注释设置_eclipse添加方法注释模板

2、效果图展示

idea文档注释设置_eclipse添加方法注释模板

三、方法注释模板

1、创建模板

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

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

1、File–>Settings–>Editor–>Live Templates

idea文档注释设置_eclipse添加方法注释模板

(1)新建组:命名为userDefine

idea文档注释设置_eclipse添加方法注释模板

(2)新建模板:命名为*

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

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

获取方法返回值的methodReturnType()

idea文档注释设置_eclipse添加方法注释模板

(3)设置生成注释的快捷键

idea文档注释设置_eclipse添加方法注释模板

2、设置模板内容-IDEA格式模板

注意第一行,只有一个*而不是/*

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

注意:下面这段是代码,可以直接复制的!可以直接复制的!可以直接复制的!不要再问我为什么都是图片了,留着眼睛干啥?

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

3、设置模板内容-JavaDoc格式

*
 * 
 * @author 程普楠
 * @date $time$ $date$ $param$ $return$
 **/

4、设置模板应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可

(如果曾经修改过,则显示为change而不是define)

idea文档注释设置_eclipse添加方法注释模板

idea文档注释设置_eclipse添加方法注释模板

5、设置参数

选择右侧的Edit variables按钮

PS:第4步和第5步顺序不可颠倒,否则第5步将获取不到方法

idea文档注释设置_eclipse添加方法注释模板

1、IDEA格式的模板只需要为每个参数选择对应的方法即可

idea文档注释设置_eclipse添加方法注释模板

2、JavaDoc格式的需要自定义参数以及返回值的实现方式

获取参数实现方式:

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())

返回值实现方式:

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

6、效果图

创建方法,在方法上面写:/*+模板名+Enter–>/**+Enter

IDEA格式的注释效果图:

idea文档注释设置_eclipse添加方法注释模板

JavaDoc格式的注释效果图:

idea文档注释设置_eclipse添加方法注释模板

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/182684.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • webstrom激活码2021[最新免费获取]「建议收藏」

    (webstrom激活码2021)JetBrains旗下有多款编译器工具(如:IntelliJ、WebStorm、PyCharm等)在各编程领域几乎都占据了垄断地位。建立在开源IntelliJ平台之上,过去15年以来,JetBrains一直在不断发展和完善这个平台。这个平台可以针对您的开发工作流进行微调并且能够提供…

    2022年3月27日
    128
  • IDEA的优化配置

    IDEA的优化配置前言IDEA全称IntelliJIDEA,是java编程语言开发的集成环境。IntelliJ在业界被公认为最好的java开发工具,尤其在智能代码助手、代码自动提示、重构、JavaEE支持、各类版本工具(git、svn等)、JUnit、CVS整合、代码分析、创新的GUI设计等方面的功能可以说是超常的。idea的优化可以使我们更得心应手的高效开发设置优化方法分割线一个文件可能会有一个或多个方法,堆积在一起使人眼花缭乱。方法分割线可以是我们快速区分方法。File——Setting——Edi

    2022年5月21日
    49
  • 当前汇总(最新序列号破解)「建议收藏」

    当前汇总(最新序列号破解),https://javaforall.net/100143.html。详细ieda激活码不妨到全栈程序员必看教程网一起来了解一下吧!

    2022年3月20日
    45
  • IDEA注释快捷键[通俗易懂]

    IDEA注释快捷键[通俗易懂]IDEA可以使用快捷键添加行注释Ctrl+/、块注释Ctrl+Shift+/,还可以快速生成类注释、方法注释等,下面就介绍这几种快捷键的用法.[1]行注释Ctrl+/首先你的光标要处于这一行,处于这行的哪个位置都可以,按Ctrl+/,就可以往行首添加”//”,将该行注释掉。再次按Ctrl+/,可以去掉该行注释。[2]块注释Ctrl+Shift+/使用块注释需要先选中要注释的块。…

    2022年8月15日
    28
  • phpstorm激活码失效破解方法[通俗易懂]

    phpstorm激活码失效破解方法,https://javaforall.net/100143.html。详细ieda激活码不妨到全栈程序员必看教程网一起来了解一下吧!

    2022年3月14日
    112
  • mac. navcat 激活码【2022最新】2022.02.19

    (mac. navcat 激活码)本文适用于JetBrains家族所有ide,包括IntelliJidea,phpstorm,webstorm,pycharm,datagrip等。IntelliJ2021最新激活注册码,破解教程可免费永久激活,亲测有效,下面是详细链接哦~https://javaforall.net/100143.html…

    2022年4月1日
    41

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号