java官方文档、java官方文档去哪儿找 收藏 0

如何理解Java中的包机制，如何有效使用JavaDoc生成文档

一般用公司域名倒置作为包名：如百度网址www.baidu.com,包命名为com.baidu.www(com.yang)

包必须在类的最上面，导入包使用语句import package 包名.(是通配符代表包名下所有内容)

搜索：百度搜阿里巴巴开发手册学习Java基础

JavaDoc命令是用来生成自己API文档的

jdk帮助文档(浏览器搜索)

选择类右键选Show in explorer可进入类存储地址，在类地址前进入cmd，并输入javadoc -encoding UTF-8 -charset UTF-8 类名.java，执行后会在类存储地址生成index.html文件，点开之后是我们自己写的类的帮助文档说明

idea生成Javadoc文档

1. 首先新建一个文件夹，用来专门存放Javadoc文档
2. 打开idea选择要生成文档的代码
3. 选择之后就看idea的顶部有一个Tools的菜单，选择Generate JavaDoc这个选项
4. 然后会弹出一个界面，然后在Output directory 输入框后面的按钮点击进去选择刚才创建的文件夹
5. 然后在下面的locale框中输入zh_CN,这个代表的就是中文，输完之后在locale下面的框中输入-encoding utf-8 -charset utf-8
6. 最后点击ok，等待文件生成完毕之后，执行后会在JavaDoc文件夹生成index.html文件，点开之后是我们自己写的类的帮助文档说明

SpringBoot 优雅整合Swagger Api 自动生成文档

一个好的可持续交付的项目，项目说明，和接口文档是必不可少的，swagger api 就可以帮我们很容易自动生成api 文档，不需要单独额外的去写，无侵入式，方便快捷大大减少前后端的沟通方便查找和测试接口提高团队的开发效率方便新人了解项目，剩余的时间就可以去约妹子啦

这里我们自己去整合swagger api比较麻烦，要导入好几个包，有大神帮我们写好了轮子kinfe4j直接对应SpringBoot的启动项，而且在不影响原来使用功能上界面ui做了美化功能做了增强 我们直接整合这个就好了

正如官网所说

kinfe4j官方文档点击这里

为我们为swagger配置更多的接口说明

抽出api文档配置模版信息为属性文件方便复用

在你的Controller上添加swagger注解

注意如启用了访问权限，还需将swagger相关uri允许匿名访问

重启服务，自带api文档访问链接为/doc.html界面如下:

相比较原来界面UI更加漂亮了，信息更完善功能更强大

用在请求的类上，表示对类的说明，也代表了这个类是swagger2的资源

参数：

1. tags：说明该类的作用，参数是个数组，可以填多个。
2. value=\”该参数没什么意义，在UI界面上不显示，所以不用配置\”
3. description = \”用户基本信息操作\”

用于请求的方法上表示一个http请求的操作

参数:

1. value用于方法描述
2. notes用于提示内容
3. tags可以重新分组（视情况而用）

用于请求方法上对请求参数，字段说明；表示对参数的添加元数据（说明或是否必填等）

参数：

1. name–参数名
2. value–参数说明
3. required–是否必填

用于java实体类上表示对类进行说明，用于参数用实体类接收

参数：

1. value–表示对象名
2. description–描述都可省略

用于方法，字段； 表示对model属性的说明或者数据操作更改

参数：

1. value–字段说明
2. name–重写属性名字
3. dataType–重写属性类型
4. required–是否必填
5. example–举例说明
6. hidden–隐藏

用于请求类或者方法上，可以不被swagger显示在页面上

用于方法表示单独的请求参数

用于方法，包含多个 @ApiImplicitParam

参数：

1. name–参数名
2. value–参数说明
3. dataType–数据类型
4. paramType–参数类型
5. example–举例说明

1. 可以给实体类和接口添加注释信息
2. 接口文档实时更新
3. 在线测试
4. kinfe4j 在swagger API只做增强，不会改变原有任何使用，更多增加使用功能点击这里进入kinfe4j官网文档

Java注解最全详解(超级详细)

Java注解是一个很重要的知识点，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行注解。

掌握好Java注解有利于学习框架底层实现。@mikechen

Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。

Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。

1.生成文档这是最常见的，也是java 最早提供的注解;

2.在编译时进行格式检查，如@Override放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出；

3.跟踪代码依赖性，实现替代配置文件功能，比较常见的是spring 2.5 开始的基于注解配置,作用就是减少配置;

4.在反射的 Class, Method, Field 等函数中，有许多于 Annotation 相关的接口,可以在反射中解析并使用 Annotation。

包括@Override、@Deprecated、@SuppressWarnings等，使用这些注解后编译器就会进行检查。

元注解是用于定义注解的注解，包括@Retention、@Target、@Inherited、@Documented、@Repeatable 等。元注解也是Java自带的标准注解，只不过用于修饰注解，比较特殊。

用户可以根据自己的需求定义注解。

JDK 中内置了以解：

如果试图使用 @Override 标记一个实际上并没有覆写父类的方法时，java 编译器会告警。

@SuppressWarnings 用于关闭对类、方法、成员编译时产生的特定警告。

1）抑制单类型的警告

2）抑制多类型的警告

3）抑制所有类型的警告

@SuppressWarnings 注解的常见参数值的简单说明:

@FunctionalInterface 用于指示被修饰的接口是函数式接口,在 JDK8 引入。

函数式接口(Functional Interface)就是一个有且仅有一个抽象方法，但是可以有多个非抽象方法的接口。

元注解是java API提供的，是用于修饰注解的注解，通常用在注解的定义上：

@ Retention用来定义该注解在哪一个级别可用，在源代码中(SOURCE)、类文件中(CLASS)或者运行时(RUNTIME)。

@Retention 源码：

RetentionPolicy 是一个枚举类型，它定义了被 @Retention 修饰的注解所支持的保留级别：

@Documented：生成文档信息的时候保留注解，对类作辅助说明

@Documented 示例

@Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

@Target源码：

ElementType 是一个枚举类型，它定义了被 @Target 修饰的注解可以应用的范围：

@Inherited：说明子类可以继承父类中的该注解

表示自动继承注解类型。 如果注解类型声明中存在 @Inherited 元注解，则注解所修饰类的所有子类都将会继承此注解。

@Repeatable 表示注解可以重复使用。

当我们需要重复使用某个注解时，希望利用相同的注解来表现所有的形式时，我们可以借助@Repeatable注解。以 Spring @Scheduled 为例：

如果不满足于文章详解，私信【架构】获取视频详解！

本文作者及来源:Renderbus瑞云渲染农场https://www.renderbus.com