获取 JavaDocs 生成的 HTML 文件

Question

我了解Javadoc 是 Sun Microsystems 的一个文档生成器，用于从 Java 源代码生成 HTML 格式的 API 文档。 我推断文档存储在 HTML 文件中。

有什么方法可以访问它吗？

如果是，它存储在哪里？

Answer 1

Javadoc这个词可以参考

• Java 源文件中的特殊 cmets（在声明之前，形式为 /** ... */）
• 将这些 cmets（以及声明本身）转换为可读输出的程序
• 输出本身，通常是 HTML 格式。

Javadoc program 包含在 Sun（或现在的 Oracle）Java 开发工具包 (JDK) 中。

如果您已经安装了 JDK（如果您进行 Java 开发则应该安装），您可以在命令行上调用它，将包名传递给文档，或一些源文件名。您还应该使用-d 选项指明输出目录。

我在下面的示例中假设以下目录（和包）结构：

• 当前目录
  • 来源
    • 德
      • dclj
        • 保罗
          • 示例
            • HelloWorld.java [包含package de.dclj.paul.examples; 和public class HelloWorld { ... }]
  • 文档

然后使用以下命令行：

javadoc -sourcpath source -d docs de.dclj.paul.examples

然后它将在 docs 目录中创建一个文档，其中包含一个您可以在 Web 浏览器中打开的 index.html，以及可以从中访问的其他文件。

有关更多详细信息，请查看上面链接的文档。有关示例输出，请查看 Java Standard API Javadoc。

如果您使用的是 IDE，那里可能有一个 generate Javadoc 按钮，IDE 甚至可能会即时显示单个类或方法的文档的格式化输出。