85、Java Javadoc 全面指南

Java Javadoc 全面指南

在 Java 开发中，编写清晰、准确的文档对于代码的维护和理解至关重要。Javadoc 工具为我们提供了一种强大的方式来生成代码文档，下面我们将详细介绍 Javadoc 的各种标签、文档编写方法、工具使用以及生成文档的查看和搜索等内容。

1. Javadoc 标签

1.1 @index 标签

<keyword> 是要索引的关键字， <description> 是关键字的描述。如果关键字是由多个单词组成的短语，需要用双引号括起来。例如：

{@index jdojo Info site (www.jdojo.com) for the Java 9 Revealed book!}

这个标签可以让关键字在生成的 Javadoc 中可搜索。

1.2 @provides 标签

JDK 9 引入了 @provides 块标签，只能在模块声明中使用，用于记录模块提供的服务实现。示例如下：

/**
 * @provides com.jdojo.prime.PrimeChecker Provides a generic implementation for the 
 * PrimeChecker service.
 */
module jdojo.prime.generic {
    requires com.