Module jdk.javadoc
Package jdk.javadoc.doclet

Interface Doclet

所有已知的实现类:
StandardDoclet
public interface Doclet
用户文档生成器必须实现此接口，如包描述中所述。每个文档生成器的实现必须提供一个公共无参数构造函数，以便工具可以实例化文档生成器。工具基础设施将与实现此接口的类交互如下：
  1. 工具将使用文档生成器类的无参数构造函数创建文档生成器的实例。
  2. 接下来，工具使用适当的区域设置和报告器调用init方法。
  3. 随后，工具调用getSupportedOptions和getSupportedSourceVersion。这些方法只会被调用一次。
  4. 根据需要，工具在文档生成器对象上调用run方法，向其提供一个DocletEnvironment对象，从中文档生成器可以确定要包含在文档中的元素。

如果创建并使用文档生成器对象而不遵循上述协议，则文档生成器的行为不受此接口规范的定义。

要启动文档生成器，请在javadoc工具命令行中传递-doclet，后跟入口类的完全限定名称（即此接口的实现）。

自 JDK 版本:
9

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Doclet.Option
    选项名称、别名、参数和描述的封装，如文档生成器所使用。

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    返回标识文档生成器的名称。
    Set<? extends Doclet.Option>
    getSupportedOptions()
    返回所有支持的选项。
    SourceVersion
    getSupportedSourceVersion()
    返回此文档生成器支持的Java编程语言版本。
    void
    init(Locale locale, Reporter reporter)
    使用给定的区域设置和错误报告器初始化此文档生成器。
    boolean
    run(DocletEnvironment environment)
    文档生成器的入口点。

  • Method Details

    • init

      void init(Locale locale, Reporter reporter)
      使用给定的区域设置和错误报告器初始化此文档生成器。此区域设置将被报告器和文档生成器组件使用。
      参数:
      locale - 要使用的区域设置
      reporter - 要使用的报告器

    • getName

      String getName()
      返回标识文档生成器的名称。名称是一个简单的标识符，不包含空格，如《Java语言规范》第6.2节“名称和标识符”中定义的那样。
      返回:
      文档生成器的名称

    • getSupportedOptions

      Set<? extends Doclet.Option> getSupportedOptions()
      返回所有支持的选项。
      返回:
      包含所有支持的选项的集合，如果没有则为空集

    • getSupportedSourceVersion

      SourceVersion getSupportedSourceVersion()
      返回此文档生成器支持的Java编程语言版本。
      返回:
      此文档生成器支持的语言版本，通常是最新版本

    • run

      boolean run(DocletEnvironment environment)
      文档生成器的入口点。随后的处理将根据此方法的指示进行。
      参数:
      environment - 可从中提取必要信息
      返回:
      成功时返回true