获取JavaDocs生成的HTML文件

Question

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

有没有办法可以访问它？

如果是，它存储在哪里？

Answer 1

Javadoc 一词可以参考

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

Javadoc program包含在Sun（或现在的Oracle）Java Development Kit（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目录中创建一个文档，其中包含index.html，您可以在Web浏览器中打开该文档，也可以从其中访问其他文件。

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

如果您使用的是IDE，那么您可能会在其中生成生成Javadoc 按钮，IDE甚至可能会动态显示单个类或方法文档的格式化输出。