0

我的理解是:

  • Java Doclet API 只是一个 API(由接口组成),植根于com.sun.javadoc
  • 当 Javadoc 运行时,它会查找要在运行时绑定到的 Doclet API impl
  • 如果不存在这样的 impl,则它使用一些默认值(因此您可以生成 Javadocs 而无需指定自己的 CSS 文件等)
  • Google 的 DocLava 就是这样一种 Doclet API impl

如果这是真的,那么如何指定一个不同的 Doclet impl(例如 DocLava)而不是默认值?如果我偏离了基础,那么 Javadoc 工具、Doclet API 和 DocLava 是如何相互关联的?

4

1 回答 1

4

如何在默认情况下指定不同的 Doclet impl(例如 DocLava)?

请参阅javadoc 工具文档命令行选项部分。您指定要与-doclet参数一起使用的文档:

-doclet class

指定启动用于生成文档的 doclet 的类文件。使用完全限定名称。此 doclet 定义内容并格式化输出。如果未使用 -doclet 选项,javadoc 将使用标准 doclet 生成默认 HTML 格式。此类必须包含 start(Root) 方法。此起始类的路径由 -docletpath 选项定义。

例如,要调用 MIF doclet,请使用:

   -doclet com.sun.tools.doclets.mif.MIFDoclet

有关运行特定 doclet 的完整工作示例,请参阅运行 MIF Doclet

有关使用 DocLava doclet 的详细信息,请参阅DocLava 入门指南:

传递给 Javadoc 以使用 Doclava 的命令行参数是:

-doclet com.google.doclava.Doclava
-docletpath ${jar.file}
于 2012-05-15T23:02:43.540 回答