java文档收集之javadoc

概要

javadoc [options] [packagenames] [sourcefiles] [@files]

options

指定命令行选项，以空格分隔。请参阅javadoc 选项、扩展选项、标准 doclet 选项和标准 doclet 提供的附加选项。

packagenames

指定要记录的包的名称，以空格分隔，例如java.lang java.lang.reflect java.awt。如果您还想记录子包，请使用该-subpackages选项来指定包。

默认情况下，javadoc在当前目录和子目录中查找指定的包。使用该-sourcepath选项指定在其中查找包的目录列表。

sourcefiles

指定要记录的 Java 源文件的名称，以空格分隔，例如Class.java Object.java Button.java。默认情况下，javadoc在当前目录中查找指定的类。但是，您可以指定类文件的完整路径并使用通配符，例如/home/src/java/awt/Graphics*.java。您还可以指定相对于当前目录的路径。

@files

指定包含javadoc任意顺序的工具选项、包名称和源文件名列表的文件的名称。

描述

该javadoc工具解析一组 Java 源文件中的声明和文档注释，并生成相应的 HTML 页面，这些页面描述（默认情况下）公共类和受保护类、嵌套类（但不是匿名内部类）、接口、构造函数、方法和字段。您可以使用该javadoc工具生成 API 文档或一组源文件的实现文档。

您可以javadoc在整个包、单个源文件或两者上运行该工具。记录整个包时，您可以使用该-subpackages选项递归遍历目录及其子目录，或者传入包名称的显式列表。当您记录各个源文件时，请传入 Java 源文件名列表。有关使用该工具的信息，请参阅Java 平台标准版 Javadoc 指南中的javadoc 概述。?javadoc

一致性

标准 doclet 不会验证文档注释内容的一致性，也不会尝试纠正文档注释中的任何错误。建议任何运行 javadoc 的人注意生成不合格输出或包含可执行内容（例如 JavaScript）的输出时可能出现的问题。标准 doclet 确实提供了doclint帮助开发人员检测文档注释中常见问题的功能；但也建议使用任何适当的一致性和其他检查工具来检查生成的输出。

有关 HTML5 文档的一致性要求的更多详细信息，请参阅HTML5 规范中的一致性要求。有关网页相关安全问题的更多详细信息，请参阅开放 Web 应用程序安全项目 (OWASP)页面。

javadoc 的选项

以下选项是核心javadoc选项，不等同于相应javac选项：

-breakiterator

用 计算第一个句子BreakIterator。第一句话被复制到包、类或成员摘要以及字母索引中。该类BreakIterator用于确定除英语之外的所有语言的句子结尾。

• 英语默认断句算法 — 在句点后跟空格或 HTML 块标记处停止，例如<P>。

• Breakiterator 断句算法 — 当下一个单词以大写字母开头时，在句号、问号或感叹号处停止，后跟一个空格。这旨在处理大多数缩写（例如“序列号有效”，但不会处理“史密斯先生”）。该-breakiterator选项不限于以数字或符号开头的 HTML 标签或句子。../filename即使嵌入到 HTML 标记中，?算法也会在 的最后一个句点处停止。

-doclet?class

使用备用 doclet 生成输出。使用完全限定名称。此 doclet 定义内容并格式化输出。如果-doclet未使用该选项，则该javadoc工具将使用标准 doclet 来生成默认 HTML 格式。该类必须包含该start(Root)方法。该起始类的路径由该-docletpath选项定义。

-docletpath?path

指定在何处查找 doclet 类文件（使用-doclet选项指定）及其依赖的任何 JAR 文件。如果起始类文件位于 JAR 文件中，则此选项指定该 JAR 文件的路径。您可以指定绝对路径或相对于当前目录的路径。如果classpathlist包含多个路径或 JAR 文件，则在 Oracle Solaris 上应使用冒号 (:) 分隔，在 Windows 上应使用分号 (;) 分隔。doclet当起始类已在搜索路径中?时，不需要此选项。

-exclude?pkglist

无条件地从 形成的列表中排除指定的包及其子包-subpackages。它排除了这些包，即使它们本来会被某些早期或以后的-subpackages选项包含在内。

以下示例将包括java.io、java.util和java.math（以及其他），但会排除以java.net和为根的包java.lang。请注意，这些示例排除java.lang.ref了java.lang.

• Oracle Solaris、Linux 和 macOS：

  javadoc -sourcepath /home/user/src -subpackages java -exclude java.net:java.lang
  

• Windows：

  javadoc -sourcepath \user\src -subpackages java -exclude java.net:java.lang
  

--expand-requires?value

指示 javadoc 工具扩展要记录的模块集。默认情况下，仅记录在命令行上明确给出的模块。支持以下值：

• transitive：另外还包括这些模块所需的所有传递依赖项。

• all: 包括所有依赖项。

-help或者--help

显示联机帮助，其中列出了所有javadoc和doclet命令行选项。

--help-extra或者-X

打印非标准选项的概要并退出。

-Jflag

直接传递flag到运行该工具的 Java 运行时环境 (JRE)?javadoc。例如，如果您必须确保系统留出 32 MB 内存来处理生成的文档，那么您可以按-Xmx如下方式调用该选项：javadoc -J-Xmx32m -J-Xms32m com.mypackage。请注意，这-Xms是可选的，因为它仅设置初始内存的大小，当您知道所需的最小内存量时，这很有用。

J和之间没有空格flag。

使用该-version选项报告用于运行该javadoc工具的 JRE 版本。

javadoc -J-version
java version "10-ea" 2018-03-20
Java(TM) SE Runtime Environment 18.3 (build 10-ea+36)
Java HotSpot(TM) 64-Bit Server VM 18.3 (build 10-ea+36, mixed mode)

-locale?name

javadoc指定该工具在生成文档时使用的区域设置。参数是区域设置的名称，如java.util.Locale文档中所述，例如en_US（英语、美国）或en_US_WIN（Windows 变体）。

指定区域设置会使javadoc工具为消息选择该区域设置的资源文件，例如导航栏中的字符串、列表和表格的标题、帮助文件内容、文件中的注释stylesheet.css等。它还指定按字母顺序排序的列表的排序顺序，以及确定第一个句子结尾的句子分隔符。该-locale选项无法确定已记录类的源文件中指定的文档注释文本的区域设置。

-package

仅显示包、受保护和公共类和成员。

-private

显示所有类和成员。

-protected

仅显示受保护的公共类和成员。这是默认设置。

-public

仅显示公共类和成员。

-quiet

关闭消息，以便仅显示警告和错误，以便于查看。它还会抑制version字符串。

--show-members?value

指定记录哪些成员（字段或方法），其中值可以是以下任意值：

• protected：默认值受保护。

• public：仅显示公共值。

• package：显示公共成员、受保护成员和包成员。

• private：显示所有成员。

--show-module-contents?value

指定模块声明的文档粒度，其中value可以是api或all。

--show-packages?value

指定哪些模块包被记录，或者包value可以在哪里。?exportedall

--show-types?value

指定记录哪些类型（类、接口等），其中value可以是以下任意类型：

• protected：默认值。显示公共类型和受保护类型。

• public：仅显示公共值。

• package：显示公共、受保护和包类型。

• private：显示所有类型。

-subpackages?subpkglist

从指定包中的源文件生成文档，并在其子包中递归生成文档。当向源代码添加新子包时，此选项非常有用，因为它们会自动包含在内。每个包参数都是不需要包含源文件的任何顶级子包（例如java）或完全限定的包（例如）。javax.swing在所有操作系统上，参数均以冒号分隔。不允许使用通配符。用于-sourcepath指定在何处查找包。此选项不处理源代码树中但不属于包的源文件。

例如，以下命令为名为java和的包javax.swing及其所有子包生成文档。

• Oracle Solaris、Linux 和 macOS：

  javadoc -d docs -sourcepath /home/user/src -subpackages java:javax.swing

• Windows：

  javadoc -d docs -sourcepath \user\src -subpackages java:javax.swing 
  

-verbose

在工具运行时提供更详细的消息javadoc。如果没有该-verbose选项，则会显示加载源文件、生成文档（每个源文件一条消息）和排序的消息。该-verbose选项会导致打印附加消息，指定解析每个 Java 源文件的毫秒数。

--version

打印版本信息。

扩展选项

以下扩展javadoc选项不等同于相应javac选项：

-Xmodule:module-name

指定正在编译的类所属的模块。

-Xold

调用旧版javadoc工具。

标准 doclet 选项

标准 doclet 提供了以下选项。

--add-stylesheet?file

为生成的文档添加附加样式表文件。可以使用此选项一次或多次来指定文档中包含的其他样式表。

命令行示例：

 javadoc --add-stylesheet new_stylesheet_1.css --add-stylesheet new_stylesheet_2.css pkg_foo 

--allow-script-in-comments

允许选项和注释中使用 JavaScript

-author

包括@author生成的文档中的文本。

-bottom?html-code

指定要放置在每个输出文件底部的文本。文本放置在页面底部、下部导航栏下方。文本可以包含 HTML 标记和空格，但如果包含，则必须将文本括在引号中。对文本中的任何内部引号使用转义字符。

-charset?name

指定该文档的 HTML 字符集。该名称应该是IANA 注册表字符集中指定的首选 MIME 名称。

例如：

javadoc -charset "iso-8859-1" mypackage 

此命令将以下行插入到每个生成的页面的头部：

<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">

该标签在HTML 标准（4197265 和 4137321） HTML 文档表示META中进行了描述。

-d?directory

javadoc指定工具保存生成的 HTML 文件的目标目录。如果省略该-d选项，则文件将保存到当前目录。该directory值可以是绝对值或相对于当前工作目录的值。该工具运行时会自动创建目标目录javadoc。

• Oracle Solaris、Linux 和 macOS：例如，以下命令生成包的文档com.mypackage并将结果保存在/user/doc/目录中：

  javadoc -d /user/doc/ com.mypackage
  

• Windows：例如，以下命令生成包的文档com.mypackage并将结果保存在\user\doc\目录中：

  javadoc -d \user\doc\ com.mypackage

-docencoding?name

指定生成的 HTML 文件的编码。该名称应该是IANA 注册表字符集中指定的首选 MIME 名称。

编码命令中可以使用三个选项javadoc。选项-encoding用于对工具读取的文件进行编码javadoc，而-docencoding和-charset选项用于对工具写入的文件进行编码。在三个可用选项中，单个编码命令中最多仅使用输入和输出编码选项。如果在命令中同时指定输入和输出编码选项，它们必须是相同的值。如果您未指定任何输出选项，则该工具将默认使用输入编码。

例如：

javadoc -docencoding "iso-8859-1" mypackage

-docfilessubdirs

递归复制文档文件子目录。

-doctitle?html-code

指定放置在概述摘要文件顶部附近的标题。标签中指定的文本title作为居中的一级标题直接放置在顶部导航栏的下方。该title标记可以包含 HTML 标记和空格，但如果包含，则必须将标题用引号引起来。标记内的其他引号title必须转义。例如，javadoc -header "<b>My Library</b><br>v1.0" com.mypackage.

-excludedocfilessubdir?name

排除具有给定名称的任何 doc 文件子目录。启用文档文件目录的深度复制。子目录和所有内容都会递归复制到目的地。例如，doc-files/example/images复制目录及其所有内容。还有一个排除子目录的选项。

-footer?html-code

指定要放置在每个输出文件底部的页脚文本。该html-code值放置在下部导航栏的右侧。该html-code值可以包含 HTML 标记和空格，但如果包含，则该html-code值必须用引号引起来。对页脚内的任何内部引号使用转义字符。

--frames

允许在生成的输出中使用帧（默认）。

-group?namep1:p2

在“概述”页面中将指定的包分组在一起。

-header?html-code

指定要放置在每个输出文件顶部的标题文本。标题位于上部导航栏的右侧。可以header包含 HTML 标签和空格，但如果包含，则header必须用引号括起来。对标题内的内部引号使用转义字符。例如，javadoc -header "<b>My Library</b><br>v1.0" com.mypackage.

-helpfile?filename

包括链接到顶部和底部导航栏中的“帮助”链接的文件。如果没有此选项，该javadoc工具将创建一个帮助文件 ，help-doc.html该文件是硬编码在javadoc工具中的。此选项允许您覆盖默认值。可以filename是任何名称，并且不限于help-doc.html.?该javadoc工具会相应地调整导航栏中的链接。例如：

• Oracle Solaris、Linux 和 macOS：

  javadoc -helpfile /home/user/myhelp.html java.awt.
  

• Windows：

  javadoc -helpfile C:\user\myhelp.html java.awt.
  

-html4

生成 HTML 4.0.1 输出。HTML 5 输出是默认输出。

-html5

生成 HTML 5 输出（默认）。

--javafx或者-javafx

启用 JavaFX 功能。

-keywords

将 HTML 关键字<META>标签添加到为每个类生成的文件中。这些标签可以帮助寻找<META>标签的搜索引擎找到页面。大多数搜索整个互联网的搜索引擎不会查看<META>标签，因为页面可能会滥用它们。将搜索限制在自己网站上的公司提供的搜索引擎可以通过查看<META>标签而受益。标签<META>包括类的完全限定名称以及字段和方法的非限定名称。不包括构造函数，因为它们与类名相同。例如，该类String以以下关键字开头：

<META NAME="keywords" CONTENT="java.lang.String class">
<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">
<META NAME="keywords" CONTENT="length()">
<META NAME="keywords" CONTENT="charAt()">

-link?url

创建指向javadoc外部引用类的现有生成文档的链接。参数url是包含外部生成的文档的目录的绝对或相对 URL?javadoc。您可以在指定的工具运行中指定多个-link选项javadoc来链接到多个文档。

一个package-list或一个element-list文件必须位于此url目录中（否则，请使用该-linkoffline选项）。

当您使用该javadoc工具记录包时，它会使用该package-list文件来确定 API 中声明的包。当您为模块生成 API 文档时，该javadoc工具使用该element-list文件来确定 API 中声明的模块和包。

该javadoc工具从相应的列表文件中读取名称，然后链接到该 URL 处的包或模块。

当该javadoc工具运行时，该url值将被复制到<A HREF>创建的链接中。因此，url必须是目录的 URL，而不是文件的 URL。

您可以使用绝对链接使url您的文档能够链接到任何网站上的文档，也可以使用相对链接仅链接到相对位置。如果使用相对链接，则传入的值应该是从目标目录（使用选项指定-d）到包含所链接的包的目录的相对路径。当指定绝对链接时，通常使用 HTTP 链接。但是，如果您想链接到没有 Web 服务器的文件系统，则可以使用文件链接。仅当想要访问生成的文档的每个人共享同一文件系统时才使用文件链接。在所有情况下以及所有操作系统上，都使用斜杠作为分隔符，无论 URL 是绝对 URL 还是相对 URL，以及https:、http:或file:如 URL 备注中指定：统一资源定位器。

-link https://<host>/<directory>/<directory>/.../<name>
-link http://<host>/<directory>/<directory>/.../<name>
-link file://<host>/<directory>/<directory>/.../<name>
-link <directory>/<directory>/.../<name>

-linkoffline?url1?url2

此选项是该选项的变体-link。它们都javadoc为外部引用的类创建指向生成文档的链接。您可以-linkoffline在指定的工具运行中指定多个选项javadoc。

如果url1只能在万维网上访问，则该-linkoffline选项消除了该javadoc工具必须具有 Web 连接才能生成文档的限制。

该-linkoffline选项的另一个用途是作为更新文档的解决方法。javadoc在完整的包或模块集上运行该工具后，您可以javadoc在较小的一组已更改的包或模块上再次运行该工具，以便更新的文件可以插入回原始集中。

例如，该-linkoffline选项采用两个参数。第一个是将字符串嵌入到链接中<a href>，第二个告诉javadoc工具在哪里可以找到package-list或element-list文件。

或url1值是包含要链接到的url2外部生成的文档的目录的绝对或相对 URL 。javadoc当相对时，该值应该是从目标目录（用选项指定-d）到所链接的包的根目录的相对路径。请参阅选项url中-link。

-linksource

创建每个源文件的 HTML 版本（带有行号）并添加来自标准 HTML 文档的链接。为其声明位于源文件中的类、接口、构造函数、方法和字段创建链接。否则，不会创建链接，例如默认构造函数和生成的类的链接。

此选项公开包含的源文件中的所有私有实现细节，包括私有类、私有字段和私有方法的主体，无论-public、-package、-protected和-private选项如何。除非您也使用该-private选项，否则并非所有私有类或接口都可以通过链接访问。

每个链接都出现在其声明中的标识符名称上。例如，该类源代码的链接Button将位于以下单词上Button：

public class Button extends Component implements Accessible

getLabel类中方法的源代码的链接Button在这个词上getLabel：

public String getLabel()

--main-stylesheet?file或者-stylesheetfile?file

指定备用样式表文件的路径，该文件包含生成的文档中使用的 CSS 样式的定义。此选项允许您覆盖默认值。如果您不指定该选项，该javadoc工具将创建并使用默认样式表。文件名可以是任何名称，并且不限于stylesheet.css.?该--main-stylesheet选项是首选形式。

命令行示例：

 javadoc --main-stylesheet main_stylesheet.css pkg_foo

-nocomment

抑制整个评论正文，包括主要描述和所有标签，并仅生成声明。此选项允许您重用最初用于不同目的的源文件，以便您可以在新项目的早期阶段生成框架 HTML 文档。

-nodeprecated

防止生成文档中任何已弃用的 API。这与该-nodeprecatedlist选项的作用相同，并且在文档的其余部分中不会生成任何已弃用的 API。当您不想被已弃用的代码分散注意力时，这在编写代码时非常有用。

-nodeprecatedlist

防止生成包含已弃用 API 列表 (?deprecated-list.html) 以及导航栏中指向该页面的链接的文件。该javadoc工具在文档的其余部分中继续生成已弃用的 API。当您的源代码不包含已弃用的 API 并且您希望使导航栏更清晰时，这非常有用。

--no-frames

禁止在生成的输出中使用帧。

-nohelp

省略输出每页顶部和底部导航栏中的帮助链接。

-noindex

省略生成文档中的索引。默认情况下会生成索引。

-nonavbar

防止生成导航栏、页眉和页脚，这些内容通常位于生成页面的顶部和底部。该-nonavbar选项对选项没有影响-bottom。-nonavbar当您只对内容感兴趣而无需导航时（例如，当您将文件转换为 PostScript 或 PDF 以便打印时），该选项非常有用?。

-noqualifier?name1:name2...

从输出中排除限定符列表。包名称从出现类或接口名称的位置删除。

以下示例省略了所有包限定符：-noqualifier all.

以下示例省略了java.lang和java.io包限定符：-noqualifier java.lang:java.io.

以下示例省略了以java和子包开头的包com.sun限定符，但不省略javax: -noqualifier java.*:com.sun.*。

如果由于之前的行为而出现包限定符，则可以适当缩短名称。-noqualifier无论是否使用?该选项，该规则都有效。

-nosince

从生成的文档中省略Since与标签关联的部分@since。

-notimestamp

隐藏时间戳，该时间戳隐藏在每个页面顶部附近生成的 HTML 中的 HTML 注释中。-notimestamp当您想要javadoc在两个源库上运行该工具并获取它们之间的差异时，该选项非常有用，因为它可以防止时间戳导致 a?diff（否则diff每个页面上都会出现 a）。时间戳包括javadoc工具版本号。

-notree

从生成的文档中省略类和接口层次结构页面。这些是您使用导航栏中的“树”按钮访问的页面。默认情况下会生成层次结构。

--override-methods (detail|summary)

在详细信息或摘要部分记录重写的方法。

-overview?filename

指定该javadoc工具应从 指定的源文件中检索概述文档的文本，filename并将其放置在“概述”页面 (?overview-summary.html) 上。使用文件名指定的相对路径是相对于当前工作目录的。

虽然您可以为该filename值使用任何名称并将其放置在您想要的路径中的任何位置，但通常会对其进行命名overview.html并将其放置在源树中包含最顶层包目录的目录中。在此位置，记录包时不需要路径，因为该-sourcepath选项指向该文件。

• Oracle Solaris、Linux 和 macOS：例如，如果java.lang包的源代码树为/src/classes/java/lang/，则您可以将概述文件放置在/src/classes/overview.html。

• Windows：例如，如果java.lang包的源代码树是\src\classes\java\lang\，那么您可以将概述文件放在\src\classes\overview.html

仅当您将两个或多个包名称传递给工具时，才会创建概述页面javadoc。概览页面的标题由 设定-doctitle。

-serialwarn

生成缺少标签的编译时警告@serial。默认情况下，javadoc不生成串行警告。使用此选项显示串行警告，这有助于正确记录默认的可序列化字段和writeExternal方法。

-sourcetab?tablength

指定每个制表符在源中使用的空格数。

-splitindex

将索引文件按字母顺序拆分为多个文件，每个字母一个文件，再加上一个用于以非字母符号开头的任何索引条目的文件。

-tag?name:locations:header

指定单个参数自定义标签。对于javadoc拼写检查标签名称的工具，重要的是-tag为源代码中存在的每个自定义标签添加一个选项，禁用（使用X）当前运行中未输出的标签。冒号 (:) 始终是分隔符。该-tag选项以粗体输出标记标题 ，header其后的下一行是来自其单个参数的文本。与任何块标签类似，参数文本可以包含内联标签，这些标签也会被解释。输出类似于标准的单参数标签，例如@return和@author标签。省略header值会导致tagname成为标题。

-taglet?class

指定用于生成该标记的文档的 taglet 的完全限定名称。使用值的完全限定名称class。此 taglet 还定义自定义标记具有的文本参数的数量。taglet 接受这些参数，处理它们并生成输出。

Taglet 对于块或内联标签很有用。它们可以有任意数量的参数并实现自定义行为，例如使文本加粗、格式化项目符号、将文本写入文件或启动其他进程。Taglet 只能确定标签应出现在何处以及以何种形式出现。所有其他决定均由 doclet 做出。taglet 不能执行诸如从包含的类列表中删除类名之类的操作。但是，它可能会执行副作用，例如将标记的文本打印到文件或触发另一个进程。使用该-tagletpath选项指定 taglet 的路径。以下示例在生成的页面中将 To Do taglet 插入到Parameters 之后、Throws 之前。

-taglet com.sun.tools.doclets.ToDoTaglet
-tagletpath /home/taglets 
-tag return
-tag param
-tag todo
-tag throws
-tag see

或者，您可以使用该-taglet选项代替其-tag选项，但这可能难以阅读。

-tagletpath?tagletpathlist

指定查找 taglet 类文件的搜索路径。可以tagletpathlist包含多个路径，用冒号 (?:) 分隔它们。该javadoc工具搜索指定路径的所有子目录。

-top?html-code

指定要放置在每个输出文件顶部的文本。

-use

创建类和包使用页面。包括每个记录的类和包的一个“使用”页面。该页面描述了哪些包、类、方法、构造函数和字段使用指定类或包的任何 API。给定类 C，使用类 C 的事物将包括 C 的子类、声明为 C 的字段、返回 C 的方法以及具有 C 类型参数的方法和构造函数。例如，您可以查看该类型的“使用”页面String。由于类getName中的方法java.awt.Font返回类型String，因此该getName方法会使用String，因此该getName方法会出现在“使用”页面上String。本文档仅记录 API 的使用，而不记录实现。当一个方法使用String在其实现中，但不将字符串作为参数或返回字符串，这不被视为使用String。要访问生成的 Use 页面，请转到类或包并单击导航栏中的Use 链接。

-version

在生成的文档中包含版本文本。默认情况下会省略此文本。javadoc要了解您正在使用的工具版本，请使用该-J-version选项。

-windowtitle?title

指定要放置在 HTML 标记中的标题<title>。标记中指定的文本title出现在窗口标题以及某人为此页面创建的任何浏览器书签（最喜欢的位置）中。该标题不应包含任何 HTML 标记，因为浏览器无法正确解释它们。在标记内的任何内部引号上使用转义字符title。如果-windowtitle省略该选项，则该工具将使用该选项javadoc的值。例如，。?-doctitle-windowtitlejavadoc -windowtitle "My Library" com.mypackage

标准 doclet 提供的附加选项

以下是标准 doclet 提供的附加选项，如有更改，恕不另行通知。其他选项可能不太常用或被视为高级选项。

-Xdoclint

启用针对 Javadoc 注释中问题的建议检查。

-Xdoclint:(all|none|[-]group)

启用或禁用针对错误引用、缺乏可访问性、缺少javadoc注释的特定检查，并报告无效javadoc语法和缺少 HTML 标记的错误。

此选项使该javadoc工具能够检查生成的输出中包含的所有文档注释。-public您可以使用标准选项、-protected、-package和 来选择要包含在生成的输出中的项目-private。

-Xdoclint启用后，它会报告与javac命令类似的消息的问题。该javadoc工具会打印一条消息、源代码行的副本以及指向检测到错误的确切位置的插入符号。消息可能是警告或错误，具体取决于其严重性以及生成的文档通过验证器运行时导致错误的可能性。例如，错误的引用或缺失的javadoc注释不会导致该javadoc工具生成无效的 HTML，因此这些问题会报告为警告。语法错误或缺少 HTML 结束标记会导致该javadoc工具生成无效输出，因此这些问题将报告为错误。

该-Xdoclint选项根据请求的标记验证输入注释。

默认情况下，该-Xdoclint选项处于启用状态。使用选项禁用它-Xdoclint:none。

以下选项更改该-Xdoclint选项报告的内容：

• -Xdoclint none：禁用该-Xdoclint选项

• -Xdoclint?group：启用group检查

• -Xdoclint all：启用所有检查组

• -Xdoclint all,-groupgroup：启用除检查?之外的所有检查

该group变量具有以下值之一：

• accessibility：检查可访问性检查器检测到的问题（例如，标签中未指定标题或摘要属性<table>）。

• html：检测高级 HTML 问题，例如将块元素放入内联元素中，或者不关闭需要结束标记的元素。这些规则是根据所选的标准 doclet 输出生成从HTML 4 规范或HTML 5 规范派生的。html这种类型的检查使该javadoc工具能够检测某些浏览器可能无法按预期解释的 HTML 问题。

• missing：检查是否缺少 Javadoc 注释或标签（例如，缺少注释或类，或者@return方法上缺少标签或类似标签）。

• reference：检查与标记中对 Java API 元素的引用相关的问题?javadoc（例如，在 中找不到的项目@see或@param).

• syntax：检查低级问题，例如未转义的尖括号 (<和>) 和与号 (?&) 以及无效javadoc标签。

-Xdoclint您可以多次指定该选项以启用该选项来检查多个类别中的错误和警告。或者，您可以使用前面的选项指定多个错误和警告类别。例如，使用以下任一命令检查文件中的 HTML、语法和可访问性问题filename。

javadoc -Xdoclint:html -Xdoclint:syntax -Xdoclint:accessibility filename
javadoc -Xdoclint:html,syntax,accessibility filename

-Xdoclint/package:([-])?packages

启用或禁用特定包中的检查。packages是逗号分隔的包说明符列表。包说明符是包的限定名称或后跟 的包名称前缀*，它扩展到给定包的所有子包。在包说明符前面加上破折号 (?-) 以禁用对指定包的检查。

-Xdocrootparent?url

将注释中后面的所有@docRoot项目替换为.?/..javadocurl