课时48:JavaDoc文档简述
摘要:主要讲解了Java DOC文档的使用方法和技巧。首先,介绍了Java DOC的简介,强调了在开发过程中需要大量使用API文档。其次,详细解析了Java DOC的组成结构,包括位的完整定义、类的相关说明以及方法的详细解释。
1. Java DOC简介
2. Java DOC文档的组成
下面介绍String类的常用方法。在实际的项目开发过程之中,只要是项目都一定会存在String类的定义。所以掌握这个位置中的所有的常用的处理方法,对开发者而言是非常重要的。
01. Java DOC简介
在以后进行开发的这个过程之中,肯定要大量的去使用java 的API 文档。这个文档它就叫一个叫 java DOC,这个文档可以直接通过 oracle在线访问进行查看,oracle在线访问的地址如下:https://docs.oracle.com/javase/9/docs/api/overview-summary.html
。可以直接访问网址,也可以在百度搜一下“java Doc9”进行搜索。
目前该网址变化较大,分别是JDK1.9版本前后两个部分。在JDK1.9之前,所有的java 中的常用位库都会在 JVM 启动的时候进行全部的加载。这样的话呢,实际上性能会有所下降。
所以在 DK1.9开始,提供有模块化的设计,比如说将一些做程序位放在了不同的模块里面。这样,当我们打开文档之后,首先能够发现Java SE 有很多的模块。
所以对于刚刚开始接触这个文档的用户,实际上并不是一个好消息。因为这样的话会使文档的查询更加困难一些。但是,这个文档大家会慢慢使用熟悉。
虽然习惯用 java 开发,但第一次接触模块化操作的过程还是很费劲。我们可以看到有一个名为“Java.Base”的模块,Base 模块里面实际上就描述的是一些常见的基础性模块。再往下浏览才是包的部分,后面会慢慢介绍。
在整个 java 基础或者开发过程中,你知道的包越多,就表示你学的越明白,用的越熟练。在模块之中,我们会包含有大量的程序开发包,如果现在要想去看String类的相关定义,则可以打开“Java.lang
”这个包。
于是,我们可以发现有String类的相关介绍,这样可以打开它,就可以查看方法了。如果该文档的形式结构对于大家现在来说有点困难,也可以查看JDK1.9版本的文档。但是在1.9版本中,我们可以看到一些更新的资料。
02. Java DOC文档的组成
下面介绍JavaDoc文档的组成。首先,String是系统提供的一个较为标准的类,所以以这个类的文档结构进行说明,一般文档里面的组成会有如下几个部分:
类的完整定义 |
|
类的相关说明 |
|
成员属性的摘要 |
|
构造方法摘要 (如果看见有“deprecated”描述的方法表示不建议使用。) |
|
方法摘要 (不同版本有所差别)左边为返回值,右边为相应的名称和参数值。 |
|
最后的部分就是对于方法和成员的详细解释。下图就是一个方法的详细说明,详细解释了该方法的作用、参数设置情况以及返回值的信息。
但需要强调的是,文档一般都会有一些 “假”的中文翻译版(自动翻译版)。对于这些翻译版文档,我们最好不要使用,在整个Java 的开发中,涉及到的文档有几十份,甚至上百份且没有中文版本。
现在还没有习惯于查阅英文文档,那么后面的文档就很难看懂,所以对于文档,千万别用中文版本,只查阅英文或日文版本的文档。