Javadoc 选项
-overview i>path\filename
指定 javadoc 应该从 path\filename 所指定的“源”文件中获取概述文档，并将它放到概述页中（overview-summary.html）。其中 path\filename 是相对于 -sourcepath 的相对路径名。
尽管可对 filename 使用任何名字并将它放在 path 指定的任何地方，但是通常将它命令为 overview.html 并将它放入包含最顶级包目录的源目录树中。在该位置，建立包文档时不需要 path，因为 -sourcepath 将指向该文件。例如，如果 java.lang 包的源目录树是 /src/classes/java/lang/，则可以概述文件放到 /src/classes/overview.html。参见 实际示例。
-public
只显示公有类及成员。-protected
只显示受保护的和公有的类及成员。这是缺省状态。-package
只显示包、受保护的和公有的类及成员。-private
显示所有类和成员。-help
显示联机帮助，它将列出这些 javadoc 和 doclet 命令行选项。-doclet class
指定启动用于生成文档的 doclet 的类文件。该 doclet 定义了输出的内容和格式。如果未使用 -doclet 选项，则 javadoc 使用标准 doclet 生成缺省 HTML 格式。该类必须包含 start(Root) 方法。该启动类的路径由 -docletpath 选项定义。-docletpath classpathlist
指定 doclet 类文件的路径，该类文件用 -doclet 选项指定。如果 doclet 已位于搜索路径中，则没有必要使用该选项。-1.1
生成具有用 Javadoc 1.1 生成的文档的外观和功能的文档。也就是说，页的背景为灰色，用图像做页眉，使用 bullet 列表而不是表格，具有单级目的目录结构，不包含继承 API，不使用 HTML 框架，并且不支持内部类。该选项还将索引分割成每个字母一个文件。如果想要这种外观，则该选项比 javadoc 1.1 优越之处在于修正了一些错误。
不是所有选项都能用于 -1.1 选项。为了查看哪些选项可用，可执行： C:> javadoc -1.1 -help在该列表中显示的 -footer 选项在功能上与本页中其他地方介绍的 -bottom 选项相同。而 -title 选项在功能上与 -doctitle 相同。
-sourcepath sourcepathlist
当将包名传递到 javadoc 命令中时，指定查找源文件（.java）的搜索路径。注意只有当用 javadoc 命令指定包名时才能使用 sourcepath 选项 -- 它将不会定位传递到 javadoc 命令中的 .java 文件。如果省略 -sourcepath，则 javadoc 使用类路径查找源文件（参见 -classpath）。
将 sourcepathlist 设置成正在生成其文档的包的源树的根目录。例如，假定想要为叫作 com.mypackage 的包建立文档，其源文件位于：C:\user\src\com\mypackage\*.java在这种情况下，将把 sourcepath 指定为 C:\user\src，该目录包含 com\mypackage，然后提供包名 com.mypackage：javadoc -sourcepath C:\user\src com.mypackage这是相当容易记忆的，注意如果将源路径和包名级联到一起，并将点号改为斜杠“/”，则最后将得到该包的完整路径：C:\user\src\com\mypackage.
-classpath classpathlist
指定 javadoc 将在其中查找 引用类 的路径 -- 引用类是指带文档的类加上它们引用的任何类。Javadoc 将搜索指定路径的所有子目录。classpathlist 可以包含多个路径，它们用分号分隔。有关如何指定 classpathlist，请遵循 类路径 文档中的指令。
如果省略 -sourcepath，则 Javadoc 使用 -classpath 查找源文件和类文件（为了向后兼容性）。因而，如果想要在不同的路径中搜索源文件和类文件，则应使用 -sourcepath 和 -classpath 两个选项。例如，如果想要建立 com.mypackage 的文档，其类位于目录 C:\user\src\com\mypackage 中，并且该包依赖于 C:\user\lib 中的库，则将会指定： C:> javadoc -classpath \user\lib -sourcepath \user\src com.mypackage与其他工具一样，如果不指定 -classpath，则 Javadoc 将使用 CLASSPATH 环境变量（如果它已设置）。如果二者都未设置，则 Javadoc 将从当前目录中搜索类。有关 Javadoc 如何使用 -classpath 查找用户类及相关扩展类和自举类的深入介绍，参见 如何查找类。
-bootclasspath classpathlist
指定自举类所在路径。它们名义上是 Java 平台类。这个 bootclasspath 是 Javadoc 将用来查找源文件和类文件的搜索路径的一部分。有关详细信息，参见 如何查找类。在 classpathlist 中用分号（;）分隔目录。-extdirs dirlist
指定扩展类所在的目录。它们是任何使用 Java 扩展机制的类。这个 extdirs 是 Javadoc 将用来查找源文件和在文件的搜索路径的一部分。有关详细信息，参见上面的 -classpath。在 dirlist 中用分号（;）分隔目录。-verbose
在 javadoc 运行时提供更详细的信息。不使用 verbose 选项时，将显示加载源文件、生成文档（每个源文件一条信息）和排序的信息。verbose 选项导致打印额外的信息，指定解析每个 java 源文件的毫秒数。-locale language_country_variant
指定 javadoc 在生成文档时使用的环境。该参数为环境名，如 java.util.Locale 文档中所述，例如 en_US（英语，美国）或 en_US_WIN（Windows 变量）。
指定环境将导致 javadoc 为各种信息（导航栏中的字符串、列表和表格的标题、帮助文件内容、stylesheet.css 中的注释，等等）选择使用该环境的资源文件。它还指定按字母次序排序列表的排序次序，以及用于确定第一句结束的语句分隔符。它不决定带文档类的源文件中指定的文档注释文本的环境。
-encoding name
指定源文件编码名，例如 EUCJIS/SJIS。如果未指定该选项，则使用平台缺省转换器。-Jflag
将 flag 直接传递给运行 javadoc 的运行时系统 java。注意在 J 和 flag 之间不能有空格。不知算不算全？？？
-overview i>path\filename
指定 javadoc 应该从 path\filename 所指定的“源”文件中获取概述文档，并将它放到概述页中（overview-summary.html）。其中 path\filename 是相对于 -sourcepath 的相对路径名。
尽管可对 filename 使用任何名字并将它放在 path 指定的任何地方，但是通常将它命令为 overview.html 并将它放入包含最顶级包目录的源目录树中。在该位置，建立包文档时不需要 path，因为 -sourcepath 将指向该文件。例如，如果 java.lang 包的源目录树是 /src/classes/java/lang/，则可以概述文件放到 /src/classes/overview.html。参见 实际示例。
-public
只显示公有类及成员。-protected
只显示受保护的和公有的类及成员。这是缺省状态。-package
只显示包、受保护的和公有的类及成员。-private
显示所有类和成员。-help
显示联机帮助，它将列出这些 javadoc 和 doclet 命令行选项。-doclet class
指定启动用于生成文档的 doclet 的类文件。该 doclet 定义了输出的内容和格式。如果未使用 -doclet 选项，则 javadoc 使用标准 doclet 生成缺省 HTML 格式。该类必须包含 start(Root) 方法。该启动类的路径由 -docletpath 选项定义。-docletpath classpathlist
指定 doclet 类文件的路径，该类文件用 -doclet 选项指定。如果 doclet 已位于搜索路径中，则没有必要使用该选项。-1.1
生成具有用 Javadoc 1.1 生成的文档的外观和功能的文档。也就是说，页的背景为灰色，用图像做页眉，使用 bullet 列表而不是表格，具有单级目的目录结构，不包含继承 API，不使用 HTML 框架，并且不支持内部类。该选项还将索引分割成每个字母一个文件。如果想要这种外观，则该选项比 javadoc 1.1 优越之处在于修正了一些错误。
不是所有选项都能用于 -1.1 选项。为了查看哪些选项可用，可执行： C:> javadoc -1.1 -help在该列表中显示的 -footer 选项在功能上与本页中其他地方介绍的 -bottom 选项相同。而 -title 选项在功能上与 -doctitle 相同。
-sourcepath sourcepathlist
当将包名传递到 javadoc 命令中时，指定查找源文件（.java）的搜索路径。注意只有当用 javadoc 命令指定包名时才能使用 sourcepath 选项 -- 它将不会定位传递到 javadoc 命令中的 .java 文件。如果省略 -sourcepath，则 javadoc 使用类路径查找源文件（参见 -classpath）。
将 sourcepathlist 设置成正在生成其文档的包的源树的根目录。例如，假定想要为叫作 com.mypackage 的包建立文档，其源文件位于：C:\user\src\com\mypackage\*.java在这种情况下，将把 sourcepath 指定为 C:\user\src，该目录包含 com\mypackage，然后提供包名 com.mypackage：javadoc -sourcepath C:\user\src com.mypackage这是相当容易记忆的，注意如果将源路径和包名级联到一起，并将点号改为斜杠“/”，则最后将得到该包的完整路径：C:\user\src\com\mypackage.
-classpath classpathlist
指定 javadoc 将在其中查找 引用类 的路径 -- 引用类是指带文档的类加上它们引用的任何类。Javadoc 将搜索指定路径的所有子目录。classpathlist 可以包含多个路径，它们用分号分隔。有关如何指定 classpathlist，请遵循 类路径 文档中的指令。
如果省略 -sourcepath，则 Javadoc 使用 -classpath 查找源文件和类文件（为了向后兼容性）。因而，如果想要在不同的路径中搜索源文件和类文件，则应使用 -sourcepath 和 -classpath 两个选项。例如，如果想要建立 com.mypackage 的文档，其类位于目录 C:\user\src\com\mypackage 中，并且该包依赖于 C:\user\lib 中的库，则将会指定： C:> javadoc -classpath \user\lib -sourcepath \user\src com.mypackage与其他工具一样，如果不指定 -classpath，则 Javadoc 将使用 CLASSPATH 环境变量（如果它已设置）。如果二者都未设置，则 Javadoc 将从当前目录中搜索类。有关 Javadoc 如何使用 -classpath 查找用户类及相关扩展类和自举类的深入介绍，参见 如何查找类。
-bootclasspath classpathlist
指定自举类所在路径。它们名义上是 Java 平台类。这个 bootclasspath 是 Javadoc 将用来查找源文件和类文件的搜索路径的一部分。有关详细信息，参见 如何查找类。在 classpathlist 中用分号（;）分隔目录。-extdirs dirlist
指定扩展类所在的目录。它们是任何使用 Java 扩展机制的类。这个 extdirs 是 Javadoc 将用来查找源文件和在文件的搜索路径的一部分。有关详细信息，参见上面的 -classpath。在 dirlist 中用分号（;）分隔目录。-verbose
在 javadoc 运行时提供更详细的信息。不使用 verbose 选项时，将显示加载源文件、生成文档（每个源文件一条信息）和排序的信息。verbose 选项导致打印额外的信息，指定解析每个 java 源文件的毫秒数。-locale language_country_variant
指定 javadoc 在生成文档时使用的环境。该参数为环境名，如 java.util.Locale 文档中所述，例如 en_US（英语，美国）或 en_US_WIN（Windows 变量）。
指定环境将导致 javadoc 为各种信息（导航栏中的字符串、列表和表格的标题、帮助文件内容、stylesheet.css 中的注释，等等）选择使用该环境的资源文件。它还指定按字母次序排序列表的排序次序，以及用于确定第一句结束的语句分隔符。它不决定带文档类的源文件中指定的文档注释文本的环境。
-encoding name
指定源文件编码名，例如 EUCJIS/SJIS。如果未指定该选项，则使用平台缺省转换器。-Jflag
将 flag 直接传递给运行 javadoc 的运行时系统 java。注意在 J 和 flag 之间不能有空格。不知算不算全？？？
@author 1.0
@deprecated 1.0
@exception 1.0
{@link} 1.2
@param 1.0
@return 1.0
@see 1.0
@serial 1.2
@serialData 1.2
@serialField 1.2
@since 1.1
@throws 1.2
@version 1.0
{@docRoot} 1.3beta
@author name-text 當使用 -author 選項時，用指定的 name-text 在產生文件中添加“Author”項。文件注釋可包含多個 @author 標記。可以對每個 @author 指定一個或多個名字。在前一種情況中，Javadoc 將在名字之間插入逗號（,）和空格。在後一種情況下，將全部文本複製到產生文件中而不進行解析。如果想要用逗號以外的本地化名字分隔符，則應每行使用這個名字。 @deprecated deprecated-text
添加注釋，指示不應再使用該 API（盡管它仍可用）。Javadoc 將 deprecated-text 移動到描述前面，用斜體顯示，並在它前面添加粗體警告： “不鼓勵使用”。
deprecated-text 的首句至少應該告訴用戶什麼時候開始不鼓勵使用該 API 及使用什麼替代它。Javadoc 僅將首句複製到概覽部分和索引中。後面的語句還可解釋為什麼不鼓勵使用它。還應包括一個指向替代 API 的 {@link} 標記（對於 Javadoc 1.2 或更新版本）： 對於 Javadoc 1.2，使用 {@link} 標記。這將在需要的地方創建內嵌鏈接。例如：
/**
* @deprecated 在 JDK 1.1 中，被 {@link #setBounds(int,int,int,int)} 取代。
*/ 對於 Javadoc 1.1，標準格式是為每個 @deprecated 標記創建 @see 標記（它不能內嵌）。
有關不鼓勵使用的資訊，參見 @deprecated 標記。
@exception class-name description @exception 標記是 @throws 的同義標記。{@link name label}
插入指向指定 name 的內嵌鏈接。該標記中 name 和 label 的語法與 @see 標記完全相同，如下所述，但是它產生內嵌鏈接而不是在“參見”部分中放置鏈接。該標記用花括號開始並用花括號結束，以使它區別於其他內嵌文本。如果在標簽內需要使用“}”，則請使用 HTML 實體表示法 }
對於一個語句中所允許的 {@link} 標記數目沒有限制。可以在文件注釋的描述部分或任何標記（例如 @deprecated、@return 或 @param）的文本部分中使用該標記。 例如，下面是一個引用 getComponentAt(int, int) 方法的注釋： 使用 {@link #getComponentAt(int, int) getComponentAt} 方法。 根據它，標準 doclet 將產生如下 HTML（假定它引用相同包中莰一個類）： 使用 <a href="Component.html#getComponentAt(int, int)">getComponentAt 方法。 它在 web 頁上顯示為： 使用 getComponentAt 方法。
@param parameter-name description 給“參數”部分添加參數。描述可繼續到下一行。 @return description 用 description 文本添加“返回”部分。該文本應描述值的返回型態和容許範圍。@since since-text 用 since-text 指定的內容給產生文件添加“Since”標題。該文本沒有特殊內部結構。該標記表示該改變或功能自 since-text 所指定的軟件版本之後就存在了。例如：
@since JDK1.1
@serial field-description 用於預設可序列化域的文件注釋中。
可選的 field-description 增強了文件注釋對域的描述能力。該組合描述必須解釋該域的意義並列出可接受值。如需要，該描述可有多行。 應該對自 Serializable 類的最初版本之後添加的每個可序列化域添加 @since 標記。 要獲得私有類的序列化形式，可使用 -private 選項。因而，要產生所有公共類和私有類的序列化形式，可用 -private 選項運行 javadoc。 有關如何使用這些標記的資訊，以及相應示例，參見 Java 對像序列化規範 中第 1.6 節“建立類的可序列化域和數據的文件。
@serialField field-name field-type field-description 建立 Serializable 類的 serialPersistentFields 成員的 ObjectStreamField 組件的文件。應該對每個 ObjectStreamField 使用一個 @serialField 標記。 @serialData data-description data-description 建立數據（尤其是 writeObject 方法所寫入的可選數據和 Externalizable.writeExternal 方法寫入的全部數據）序列和型態的文件，。
@serialData 標記可用於 writeObject、readObject、writeExternal 和 readExternal 方法的文件注釋中。