type
status
date
slug
summary
tags
category
icon
password
简介
Javadoc是专为Java语言设计的文档生成工具。它从Java源代码文件中的注释自动生成HTML格式的API文档，可以让没参与该项目的人快速上手这个项目。Javadoc是Java开发工具套件（JDK）的一部分。
【注意】只有纯的Java项目（项目中的代码都是Java代码）才会用到javadoc生成API文档。javadoc 生成的文档帮助开发者理解和使用 API，而不需要深入研究源代码。对于 Java Web 项目，由于它们往往涉及到多种技术栈（如 HTML、CSS、JavaScript、Servlets、JSP 等）和复杂的应用逻辑，生成的 API 文档可能不足以全面描述整个项目的功能和架构。Java Web 项目的开发和维护通常需要更综合的文档策略，包括设计文档、用户手册和技术说明等。此外，Java Web 应用的开发往往采用框架（如 Spring、Hibernate 等），这些框架本身已经有详尽的官方文档。因此，对于这部分内容，开发者通常会直接参考这些现成的文档，而不是通过 javadoc 生成新的文档。尽管如此，即使在 Java Web 项目中，对于那些提供公共 API 或需要被其他 Java 类直接使用的组件，使用 javadoc 来生成文档仍然是一个好的实践。这样做可以提高代码的可读性和可维护性，使团队成员和未来的开发者更容易理解这些组件的功能和用法。
一般有两种使用方式：
1、 基于命令行
macOS版JDK提供的javadoc存放位置（以macos14.4.1为例）
2、IDEA提供的javadoc工具（如Intellij IDEA）
在java项目中除Javadoc之外的其他API文档生成工具
在java项目中，除了Javadoc 之外还有其他工具可以使用：
Doxygen：是一个更通用的文档生成工具，支持多种编程语言，包括C++、C、Java、Objective-C、Python等。它可以从代码中的注释生成各种格式的文档，包括HTML、LaTeX（用于打印的PDF文档）、man页和RTF等格式。
Sphinx：最初是为Python项目开发的文档工具，但它可以通过插件如Breathe来支持Doxygen标记，因此也可以用于Java项目。Sphinx能够生成多种输出格式的文档，包括HTML、PDF和LaTeX等。当你需要为项目生成包含丰富链接和交叉引用的复杂文档时，Sphinx是一个很好的选择。
MkDocs：MkDocs是一个快速、简单且完全由Markdown驱动的静态站点生成器。它适用于创建项目文档。虽然MkDocs不是专门为Java设计的，但它因其简洁性和易用性而在Java社区中也获得了一定的使用。适用于那些偏好Markdown而不是Javadoc注释来编写文档的项目。
AsciiDoc：AsciiDoc可以被视为Markdown的“大哥”，它提供了更丰富的文本格式化选项。AsciiDoc本身是一个文本文档格式，但有工具如Asciidoctor可以将AsciiDoc文档转换为HTML、PDF等格式的文档。对于需要复杂文档结构和格式化选项的大型项目，AsciiDoc是一个很好的选择。
工具1：各版本在线官方API文档
java各版本在线官方API文档（JDK9及以后的API文档才提供了搜索功能）
工具2：Hutool
github地址：https://github.com/dromara/hutool
Hutool是一个Java工具类库，它旨在减少Java开发人员在日常编程中的重复代码量，并提高开发效率。Hutool提供了一系列的工具类，涵盖了文件操作、网络编程、日期处理、字符串处理等多个方面，使用它可以使得Java程序的编写变得更加简单快捷。
Hutool是基于JDK之上的一个辅助工具库，它并不替代JDK的功能，而是在JDK的基础上提供了更多的便捷工具，帮助开发者简化代码，提高开发效率。使用Hutool，开发者可以更加专注于业务逻辑的实现，而不需要花费太多时间在处理一些常见的基础问题上。