Module  jdk.javadoc
软件包  jdk.javadoc.doclet

Interface Doclet

  • 所有已知实现类:
    StandardDoclet


    public interface Doclet
    用户doclet必须实现此接口,如package description中所述。 Doclet的每个实现都必须提供一个公共的无参数构造函数,以供工具用来实例化doclet。 工具基础设施将与实现此接口的类进行交互,如下所示:
    1. 该工具将使用doclet类的无参数构造函数创建一个doclet的实例。
    2. 接下来,该工具使用适当的语言环境和记者调用init方法。
    3. 之后,该工具调用getSupportedOptionsgetSupportedSourceVersion 这些方法只能调用一次。
    4. 根据需要,该工具会调用doclet对象上的run方法,给出一个DocletEnvironment对象,该文档可以从该对象中确定要包含在文档中的元素。

    如果在没有遵循上述协议的情况下创建和使用doclet对象,则该接口规范未定义doclet的行为。

    要启动doclet,请在javadoc工具命令行上传递-doclet后跟入口点类的完全限定名称(即该接口的实现)。

    从以下版本开始:
    9
    • 方法详细信息

      • init

        void init​(Locale locale,
                  Reporter reporter)
        使用给定的区域设置和错误报告器初始化此doclet。 这个区域将被记者和doclet组件使用。
        参数
        locale - 要使用的语言环境
        reporter - 记者要使用
      • getName

        String getName​()
        返回标识doclet的名称。 名称是一个没有空格的简单标识符,如The Java™ Language Specification第6.2节“名称和标识符”中所定义。
        结果
        Doclet的名称
      • getSupportedOptions

        Set<? extends Doclet.Option> getSupportedOptions​()
        返回所有支持的选项。
        结果
        一个包含所有支持的选项的集合,如果没有,则为空集合
      • getSupportedSourceVersion

        SourceVersion getSupportedSourceVersion​()
        返回此doclet支持的Java编程语言的版本。
        结果
        该doclet支持的语言版本通常是最新版本
      • run

        boolean run​(DocletEnvironment environment)
        doclet的入口点。 进一步的处理将按照该方法的指示进行。
        参数
        environment - 从中可以提取基本信息
        结果
        真正的成功