课时48:JavaDoc文档简述

简介: 主要讲解了Java DOC文档的使用方法和技巧。首先,介绍了Java DOC的简介,强调了在开发过程中需要大量使用API文档。其次,详细解析了Java DOC的组成结构,包括位的完整定义、类的相关说明以及方法的详细解释。1.Java DOC简介2.Java DOC文档的组成

课时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”进行搜索。

image.png

目前该网址变化较大,分别是JDK1.9版本前后两个部分。在JDK1.9之前,所有的java 中的常用位库都会在 JVM 启动的时候进行全部的加载。这样的话呢,实际上性能会有所下降。


所以在 DK1.9开始,提供有模块化的设计,比如说将一些做程序位放在了不同的模块里面这样,当我们打开文档之后,首先能够发现Java SE 有很多模块。 

image.png

所以对于刚刚开始接触这个文档的用户,实际上并不是一个好消息。因为这样的话会使文档的查询更加困难一些但是,这个文档大家会慢慢使用熟悉。


虽然习惯用 java 开发,但第一次接触模块化操作过程还是很费劲。我们可以看到有一个名为“Java.Base”的模块,Base 模块里面实际上就描述的是一些常见的基础性模块再往下浏览才是包的部分,后面会慢慢介绍。

image.png

在整个 java 基础或者开发过程中你知道的包越多,就表示你学的越明白,用的越熟练。在模块之中,我们会包含有大量的程序开发包,如果现在要想去看String类的相关定义,则可以打开“Java.lang这个包

image.png

于是,我们可以发现有String类的相关介绍,这样可以打开它,就可以查看方法了。如果该文档的形式结构对于大家现在来说有点困难,也可以查看JDK1.9版本的文档。但是1.9版本中,我们可以一些更新的资料。

 

02. Java DOC文档的组成

 

下面介绍JavaDoc文档的组成。首先,String是系统提供的一个较为标准的,所以以这个的文档结构进行说明,一般文档里面的组成会有如下几个部分

类的完整定义

image.png

类的相关说明

image.png

成员属性的摘要

image.png

构造方法摘要

(如果看见有“deprecated”描述的方法表示不建议使用。)

1741166541643.jpg

方法摘要

(不同版本有所差别)左边为返回值,右边为相应的名称和参数值。

image.png

最后的部分就是对于方法和成员的详细解释。下图就是一个方法的详细说明,详细解释了该方法的作用、参数设置情况以及返回值的信息。

image.png

但需要强调的是,文档一般都会有一些 “假”的中文翻译版(自动翻译版)。对于这些翻译版文档,我们最好不要使用,在整个Java 的开发中,涉及到的文档有几十份,甚至上百份没有中文版本


现在没有习惯于查阅英文文档,那么后面的文档就很难看懂,所以对于文档,千万别用中文版本只查阅英文或日文版本的文档。

相关文章
|
Java Apache
如何用 Java 实现 word、excel 等文档在线预览?
java实现办公文件在线预览功能是一个大家在工作中也许会遇到的需求,网上些公司专门提供这样的服务,不过需要收费 如果想要免费的,可以用openoffice,实现原理就是:
|
存储 SQL NoSQL
SpringBoot 整合 MongoDB 超详细(一)
在前面的文章中,我们详细的介绍了 MongoDB 的配置和使用,如果你对 MongoDB 还不是很了解,也没关系,在 MongoDB 中有三个比较重要的名词:数据库、集合、文档!
12447 1
|
10月前
|
缓存 API 持续交付
阿里巴巴热卖商品推荐API接口的获取与应用
阿里巴巴推出热卖商品推荐API接口,基于AI算法,根据用户行为推荐商品,涵盖名称、价格、描述等信息。本文介绍其获取与应用方法,帮助商家和开发者提高推荐精准度和用户满意度,优化库存管理和营销策略,提升整体销售效果。
687 0
|
12月前
|
Java 数据安全/隐私保护
Java 包(package)的使用详解
Java中的包(`package`)用于组织类和接口,避免类名冲突并控制访问权限,提升代码的可维护性和可重用性。通过`package`关键字定义包,创建相应目录结构即可实现。包可通过`import`语句导入,支持导入具体类或整个包。Java提供多种访问权限修饰符(`public`、`protected`、`default`、`private`),以及丰富的标准库包(如`java.lang`、`java.util`等)。合理的包命名和使用对大型项目的开发至关重要。
775 2
|
11月前
|
IDE Java API
Javadoc的讲解使用
本文介绍了Javadoc工具的使用方法和常用标签,通过示例代码展示了如何为Java代码添加文档注释并使用Javadoc命令生成HTML格式的API文档。
357 0
|
Web App开发 编解码 Linux
FFmpeg开发笔记(四十八)从0开始搭建直播系统的开源软件架构
音视频技术广泛应用于直播系统,涵盖电视、电脑、手机直播等多种形式,并延伸至在线教育、医疗咨询和安全监控等领域。直播系统涉及实时编解码与传输,技术实现较复杂。从用户角度看,直播系统分为来源方和观看方,但在开发者视角下还需加入云平台作为中转。本文提出一套基于全开源软件的直播系统架构,分为三层:开源直播录制软件(如OBS Studio、RTMP Streamer),开源流媒体服务器(如SRS、ZLMediaKit),以及开源音视频播放器(如VLC media player、ExoPlayer)。这些组件共同构成一个高效、灵活且成本低廉的直播解决方案。
282 0
FFmpeg开发笔记(四十八)从0开始搭建直播系统的开源软件架构
|
应用服务中间件 Apache nginx
【独家揭秘】502 Bad Gateway不再神秘!五大绝招教你快速定位并解决,从此告别网络烦恼!
【8月更文挑战第19天】遇到502 "Bad Gateway"错误让不少开发者头疼。此错误指示Web服务器作为代理收到无效响应。本文将分步骤指导如何排查与解决502问题:首先检查服务器日志文件寻找线索;接着验证后端服务器状态及连通性;然后审查Web服务器配置确保代理设置无误;再检测后端服务器响应时间避免超时;最后利用抓包工具深入分析网络通信。遵循这些步骤,可助你高效定位并解决502错误。
3416 0
|
Java API Maven
如何定位、解决maven依赖冲突问题
如何定位、解决maven依赖冲突问题
600 0
如何定位、解决maven依赖冲突问题
|
数据可视化 Java API
【JAVA】javadoc,如何生成标准的JAVA API文档
【JAVA】javadoc,如何生成标准的JAVA API文档
231 0
|
消息中间件 测试技术 领域建模
DDD - 一文读懂DDD领域驱动设计
DDD - 一文读懂DDD领域驱动设计
38601 5

热门文章

最新文章