JavaDoc API 文档的组织方式

简介: JavaDoc API 文档的组织方式

JavaDoc API 文档的组织方式


此 API (应用程序编程接口) 文档包含对应于导航栏中的项目的页面, 如下所述。


概览


概览 页面是此 API 文档的首页, 提供了所有程序包的列表及其概要。此页面也可能包含这些程序包的总体说明。


程序包


每个程序包都有一个页面, 其中包含它的类和接口的列表及其概要。此页面可以包含六个类别:


  • 接口 (斜体)



  • 枚举


  • 异常错误


  • 错误


  • 注释类型



类/接口


每个类, 接口, 嵌套类和嵌套接口都有各自的页面。其中每个页面都由三部分 (类/接口说明, 概要表, 以及详细的成员说明) 组成:


  • 类继承图


  • 直接子类


  • 所有已知子接口


  • 所有已知实现类


  • 类/接口声明


  • 类/接口说明


  • 嵌套类概要


  • 字段概要


  • 构造器概要


  • 方法概要


  • 字段详细资料


  • 构造器详细资料


  • 方法详细资料


每个概要条目都包含该项目的详细说明的第一句。概要条目按字母顺序排列, 而详细说明则按其在源代码中出现的顺序排列。这样保持了程序员所建立的逻辑分组。


注释类型


每个注释类型都有各自的页面, 其中包含以下部分:


  • 注释类型声明


  • 注释类型说明


  • 必需元素概要


  • 可选元素概要


  • 元素详细资料


枚举


每个枚举都有各自的页面, 其中包含以下部分:


  • 枚举声明


  • 枚举说明


  • 枚举常量概要


  • 枚举常量详细资料


树 (类分层结构)


对于所有程序包, 有一个类分层结构页面, 以及每个程序包的分层结构。每个分层结构页面都包含类的列表和接口的列表。从java.lang.Object开始, 按继承结构对类进行排列。接口不从java.lang.Object继承。


  • 查看“概览”页面时, 单击 “树” 将显示所有程序包的分层结构。


  • 查看特定程序包, 类或接口页面时, 单击 “树” 将仅显示该程序包的分层结构。


已过时的 API


已过时的 API 页面列出了所有已过时的 API。一般由于进行了改进并且通常提供了替代的 API, 所以建议不要使用已过时的 API。在将来的实现过程中, 可能会删除已过时的 API。


索引


索引 包含按字母顺序排列的所有类, 接口, 构造器, 方法和字段的列表。


上一个/下一个


这些链接使您可以转至下一个或上一个类, 接口, 程序包或相关页面。


框架/无框架


这些链接用于显示和隐藏 HTML 框架。所有页面均具有有框架和无框架两种显示方式。



所有类


所有类链接显示所有类和接口 (除了非静态嵌套类型)。


序列化表格


每个可序列化或可外部化的类都有其序列化字段和方法的说明。此信息对重新实现者有用, 而对使用 API 的开发者则没有什么用处。尽管导航栏中没有链接, 但您可以通过下列方式获取此信息: 转至任何序列化类, 然后单击类说明的 “另请参阅” 部分中的 “序列化表格”。


常量字段值


常量字段值页面列出了静态最终字段及其值。


此帮助文件适用于使用标准 doclet 生成的 API 文档。


相关文章
|
4月前
|
API
阿里云短信服务文档与实际API不符
阿里云短信服务文档与实际API不符
|
27天前
|
开发框架 数据可视化 .NET
.NET 中管理 Web API 文档的两种方式
.NET 中管理 Web API 文档的两种方式
36 14
|
26天前
|
API 开发者
通义灵码 API 开发文档自动生成场景DEMO
通义灵码API开发文档自动生成场景DEMO展示了通过自定义指令,大模型能快速根据类代码生成Markdown格式的API文档。文档详细描述API的入参、出参,并可生成测试代码等示例,帮助开发者快速创建美观的API文档。
|
7月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
3月前
|
JSON 前端开发 API
后端开发中的API设计与文档编写指南####
本文探讨了后端开发中API设计的重要性,并详细阐述了如何编写高效、可维护的API接口。通过实际案例分析,文章强调了清晰的API设计对于前后端分离项目的关键作用,以及良好的文档习惯如何促进团队协作和提升开发效率。 ####
|
6月前
|
API 网络架构
【Azure API 管理】如何修改Azure APIM的管理员邮箱和组织名称
【Azure API 管理】如何修改Azure APIM的管理员邮箱和组织名称
|
6月前
|
Java API 数据中心
百炼平台Java 集成API上传文档到数据中心并添加索引
本文主要演示阿里云百炼产品,如何通过API实现数据中心文档的上传和索引的添加。
243 3
|
6月前
|
存储 JSON 机器人
【Azure 机器人】微软Azure Bot 编辑器系列(2) : 机器人/用户提问回答模式,机器人从API获取响应并组织答案 (The Bot Framework Composer tutorials)
【Azure 机器人】微软Azure Bot 编辑器系列(2) : 机器人/用户提问回答模式,机器人从API获取响应并组织答案 (The Bot Framework Composer tutorials)
|
7月前
|
安全 Java API
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
这篇文章介绍了Swagger,它是一组开源工具,围绕OpenAPI规范帮助设计、构建、记录和使用RESTAPI。文章主要讨论了Swagger的主要工具,包括SwaggerEditor、SwaggerUI、SwaggerCodegen等。然后介绍了如何在Nest框架中集成Swagger,展示了安装依赖、定义DTO和控制器等步骤,以及如何使用Swagger装饰器。文章最后总结说,集成Swagger文档可以自动生成和维护API文档,规范API标准化和一致性,但会增加开发者工作量,需要保持注释和装饰器的准确性。
190 0
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
|
7月前
|
开发框架 Java 测试技术
Spring Boot中的API文档生成
Spring Boot中的API文档生成