精华内容
下载资源
问答
  • 2020-09-16 22:12:43

    规则

    注意点: 良好的java doc 注释能生成更好的文档

    1:插件如何生成属性备注 ,通过获得字段备注中的注释

    /** 
    * 年龄
    */
    private Integer age;

    2:插件如何生成接口名称,通过接口上的注释,或者引用上的 注释

       /**
       * 通过ID查询
       * @param id ID主键
       * @return SysDept 部门信息
       */
        @GetMapping("/{id}")
        public R<SysDept> getById(@PathVariable Integer id) {
            return R.ok();
        }

    3:Controller

    /**
     *@description 描述
     *@menu 测试主页面(在yapi上面生成菜单)
     */   
    @RestController
    public class UserController {
    ​
    }

    4:推荐生成注释插件(默认配置)

    查看翻译不是太好,注意修改,只是生成规则

    https://gitee.com/starcwang/easy_javadoc

    idea商城中可以搜索easy_javadoc

    5:idea配置模版

    1.类上可以不用配置,但是Controller记得加@menu

    方法上

    /**
    * TODO 添加的注释吧。
    * @Param: $param$
    * @Return: $return$
    * @Author: 自己的花名
    * @Date: $data$ $time$
    */

    image-20200916155628348

    image-20200916155559277

    更多相关内容
  • 自定义生成set,get方法注释java文件,下载后可以根据我的文章中的说明步骤进行操作。
  • 通过spring插件库实现注释文档的生成; 步骤: 1、修改App.java中的几个配置信息; 2、运行App.java中的main方法; 之后即生成了代码中带规范注释的api文档
  • Java方法或类上生成注释的快捷键

    一、方法或类注释

    在一个方法或类的开头输入/**,然后按回车,自动根据参数和返回值生成注释模板,我们在这个模板上面编写即可。

    public class catTest3 {
        public static void main(String[] args) {
            List<Cat>cat=new ArrayList<>();
            Cat a=new Cat("布偶",1);
            Cat b=new Cat("大橘",2);
            Cat c=new Cat("蓝短",3);
    
            cat.add(a);
            cat.add(b);
            cat.add(c);
     //鼠标定位在想要加注解的方法上面,输入/**,然后回车键
        /**
         * 显示Cat信息
         * @param cat
         */
        private static void showCat(List<Cat> cat) {
            for (Cat c:cat) {
                System.out.println(c.getName()+","+c.getAge());
            }
         }
        }
    

    二、 自行创建模板的方法(在方法上加注释)

    一、File-->Settings-->Editor-->Live Templates
    在这里插入图片描述

    二、新建模板
    (1)新建组:命名,如:DescDefine
    (2)新建模板:命名为*
    由于IDEA生成注释的默认方式是:/*+模板名+快捷键(好比若设置模板名为add快捷键用Tab,则生成方式为/*add+Tab),若是不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()
    (3)把下面的模板代码粘贴进去
    @Author kane是作者的名字,换成自己的名字
    *

    • @Description: d e s c r i p t i o n description description
    • @Param p a r a m s params params
    • @Return r e t u r n return return
    • @Throws t h r o w s throws throws
    • @Author kane
    • @Date d a t e date date t i m e time time
      */
      (4)设置参数的获取方式:选择右侧的Edit variables按钮
      在这里插入图片描述

    (5)设置Options:
    这里将快捷键设置为Enter回车键
    在这里插入图片描述

    (6)保存

    三、测试

    在待加注释的方法前面输入: /**回车
    在这里插入图片描述

    注意

    1)由于我们自己创建的模板名也是*,故此时输入/**回车后,调用的是刚自己创建的模板,而非最开始的那个默认模板);
    2)如果我们输入的模板名是其他键,比如&,则输入/*&回车键(/*+模板名+快捷键)即可。

    三、类上加注释:

    见文章:https://blog.csdn.net/weixin_44076342/article/details/106789384
    创建类时自动生成注解的链接

    展开全文
  • 在创建类的时候直接生成注释 两种方法: 按照顺序打开File–>settings–>Editor–>File and Code Templates–>Includes–>File Header 按照顺序打开File–>settings–>Editor–>File and...

    idea类注释模板

    在创建类的时候直接生成类注释
    两种方法:

    1. 按照顺序打开File–>settings–>Editor–>File and Code Templates–>Includes–>File Header
    2. 按照顺序打开File–>settings–>Editor–>File and Code Templates–>Files–>Class

    输入类注释代码(按照自己需求来即可):

    /**
     * @author ${USER}
     * #Description ${NAME}
     * #Date: ${DATE} ${HOUR}:${MINUTE}
     */
    

    效果如下:
    在这里插入图片描述

    idea方法注释模板

    在idea中是没有直接生成方法注释的快捷键的,我们可以通过psvm、sout等类似快捷方式生成模板

    首先,依次打开File–>Settings–>Editor–>Live Templates
    然后,点击右边的”+“号,选择Template Group,创建自定义的新组,如下图所示:
    在这里插入图片描述
    选择自己的组名,点击”+”号,选择Live Template,创建新的活动模板,其中Abbreviation输入自定义的快捷字(图中为add),类似于psvm、sout,使用时输入他加上Tab键即可,如下图所示:
    在这里插入图片描述
    Template text中需要填写模板代码:

    /**
     * #Description $description$
     * @param $params$
     * @return $returns$
     * @author feizhen
     * #Date $date$
     */
    

    不过最好不要这么写,因为直接使用add+tab方式是无法在方法外面获取方法参数的,只能在方法内部获取

    为解决此问题,可以在/*后面输入add(自定义),之后按Tab键
    此时,模板代码应改写为下图所示(因为前面已有/*了)

    *
     * #Description $description$
     * @param $params$
     * @return $returns$
     * @author feizhen
     * #Date $date$
     */
    

    之后,点击Template text下方的Define,按需求选择,一般选择java即可
    在这里插入图片描述
    只有第一次会出现Define,如果是想修改,可以右键点击模板名,选择Change context,如下图所示
    ![在这里插入图片描述](https://img-blog.csdnimg.cn/20200810221658839.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxMjg2MTM4,size_16,color_FFFFFF,t_7
    最后,编辑变量,获取参数。如下图所示:
    在这里插入图片描述
    演示过程如下:
    在这里插入图片描述
    按下Tab键
    在这里插入图片描述
    可以发现,此时注释中的@param参数会被[]包起来,产生报错,对于此情况,我们可以使用脚本,不再使用idea自带的方法
    在这里插入图片描述
    脚本如下:

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

    最终效果:
    在这里插入图片描述

    展开全文
  • IDEA快速生成文档注释方法

    千次阅读 2020-04-13 16:38:46
    1.在 file > setting 中搜索 live Templates ... 创建完组后再点第一个...根据需求选择,如果是为java类和方法生成文档注释就选择java 接下来就是自定义生成的内容,将下面内容复制到Template text中 ** *@ClassNa...

    1.在 file > setting 中搜索 live Templates

    然后点击右边的加号,点击第二个创建一个模板组,取一个名字
    在这里插入图片描述

    创建完组后再点第一个生成模板配置
    在这里插入图片描述

    出来如下界面,自定义一个快捷键,然后点击define
    在这里插入图片描述
    根据需求选择,如果是为java类和方法生成文档注释就选择java
    在这里插入图片描述

    接下来就是自定义生成的内容,将下面内容复制到Template text中

    **
    *@ClassName: $name$
    *@Description $description$
    *@Author 陈平
    *@Date $date$
    *@Time $time$
    */
    

    在这里插入图片描述
    然后点击右侧Edit Variable设置值
    在这里插入图片描述
    在这里插入图片描述
    设置好后点ok,回到方法上一行
    输入 / + 刚刚设置的快捷键 + Tab 就会生成相应的文档

    实际效果如图所示
    在这里插入图片描述

    展开全文
  • 发生了一件贼蛋疼的事情,竟然一直找不到正确添加方法注释方法! 最后自己摸索到了,在此详细记录,供大家参考。测试版本为idea for mac,可能快捷键不同,但是设置等肯定是相同的生成注释打开PreferencesEditor...
  • 文章目录类注释--1打开IDEA-->File-->...File and Code Templates选择Files 下的class,然后添加每创建一个类都会自动生成一个类注释,如下类注释选择一个方法即可,不必重复操作方法注释打开IDEA--&
  • 1. 生成注释打开Preferences-->Editor-->File and Code Templates,右侧选择Filestab页,找到Class、Interface,可以看到右侧模板里引用了一个File Header.java模板,如下图:模板变量说明${PACKAGE_NAME} ...
  • 若我们使用apidoc注释快速生成接口文档的话,每个方法需要写很多注释,如果每次都收到一个个写的话,有点浪费时间,这时我们可以用自定义模板来解决,如下注释内容是我自定义模板后一键生成的: /** * @api {POST...
  • java 实体类 代码生成器 带注释
  • java快速生成接口文档方法总结

    千次阅读 2021-07-27 19:36:22
    前言 常常在项目收尾阶段,客户需要项目的接口文档,或者是一个大的sass平台,各个产品之间互相调用的时候,需要对方提供接口文档 ...这是一种最简单也最高效的快速生成接口文档的方式,也是对既有
  • idea设置Java类和方法注释模板

    千次阅读 2021-12-07 18:16:28
    idea设置Java类和方法注释模板
  • 本人手写一键生成mybatis增删改查,从java类开始,代码注释方法注释,实体注释,都有,生成Service impl dao xml 支持 mysql数据库,不实用打我。
  • java快速生成数据库文档

    千次阅读 2021-04-03 14:05:52
    倒不是难,而是比较繁琐,举例来说,像编写数据库文档这种操作来说,对于新手,甚至很多有一定开发经验的同学来说,都觉得是一件费力得事情,下面推荐一个小组件,并提供一段程序,帮助有需要得同学快速生成数据库...
  • 生成注释的get/set方法插件
  • IDEA新建Java文件自动生成注释

    千次阅读 2022-04-09 01:52:50
    在 File | Settings | Editor | File and Code Templates | Class 中输入下图内容: 图中的英文说明介绍了其他取值方式,下面是我将自己的...#parse("File Header.java") /** *@author: Laity *@Project: JavaLai
  • 类的注释设置 打开IDEA系统设置Perferences - Editor - File and Code Templates - File Header 设置 在里面添加模版 /** * @Auther: ${USER} * @Date: ${DATE} ${HOUR}:${MINUTE} * @Description: */ 每...
  • 修改数据库连接和需要生成的表名后,可直接运行生成带中文注释和注解的JavaEntity,数据库注释生成JavaEntity里
  • JAVA注释方法及格式

    千次阅读 2021-02-28 08:51:33
    JAVA注释方法及格式1、单行(single-line)--短注释://……单独行注释:在代码中单起一行注释注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释注释格式:/* 注释内容...
  • intellij自动生成java代码注释,包括java文件头部的注释java方法注释
  • get set方法生成注释和字段注释.zip,包括GetterSetterUtil.java、GetterSetterUtil.class、get set方法生成注释和字段注释.docx详细讲解如果用快捷方式生成set、get注释
  • 点击上方File -》settings -》 Editor -》LiveTemplates -》点击右侧加号 选择template group新建模板组...2.点击最下面的蓝色字体defined,然后全部勾选,或者只勾选class,因为注释是在java类中,没选好就再点击c...
  • * @version java1.8 */ public class demo1 { /** * 该类的无参构造方法 */ public demo1() { } /** *获取两数之和 * @param a 加数 * @param b 被加数 * @return 经过if语句判断后返回的String值
  • 如题: 在idea中生成方法注释的快捷方法: 在定义方法的行上面键入/**然后回车,即可自动生成方法注释。 效果如下图: 参考: https://www.cnblogs.com/niuxiaozu/p/8806331.html ...
  • 我们都阅读过 JDK API,但是庞大的API文档是怎么生成的?有谁知道 如何能保持代码的修改与代码文档的同步?这就是 javadoc 的存在目的。 这个文档将详细讲解 代码注释 怎么成为代码说明文档。
  • idea自动生成方法注释(含参数及返回值)

    万次阅读 多人点赞 2018-07-05 22:05:59
    之前有配置过一个方法注释,不过方法的参数和返回值不能自动生成,昨天偶遇一篇文章,有提到了一种配置方式,今天试了下,经过一番调试,大功告成。效果如图: File-&amp;amp;amp;gt;settings-&amp;amp...
  • java注释多行/**/快捷键是什么

    千次阅读 2021-02-12 10:02:18
    拓展资料:Java快捷键:1. 【ALT+/】此快捷键为用户编辑的好帮手32313133353236313431303231363533e58685e5aeb931333365653266,能为用户提供内容的辅助,不要为记不全方法和属性名称犯愁,当记不全类、方法和属性的...
  • java 类和方法自动添加注释

    千次阅读 2021-02-21 11:21:25
    设置文件头File Header 路径为 setting-->editor-->File and Code Templates-->Includes-->File Header /** * <p>Title: </p> * <p>...创建方法快速添加注释

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 299,963
精华内容 119,985
关键字:

java快速生成方法注释

java 订阅