模块 jdk.javadoc
包 jdk.javadoc.doclet

类 StandardDoclet

java.lang.Object
jdk.javadoc.doclet.StandardDoclet
所有已实现的接口：
Doclet
public class StandardDoclet extends Object implements Doclet
此 doclet 为指定的模块、包和类型生成 HTML 格式的文档。

用户定义的 Taglet

标准 doclet 支持用户定义的 taglets ，可用于为文档注释中的用户定义标签生成自定义输出。标准 doclet 调用的 Taglet 必须从 Taglet.toString 返回字符串，如下所示：
内嵌标签
返回的字符串必须是 流量内容 或可能出现在文档正文中的任何有效 HTML 代码片段。可能会有额外的限制，这取决于标签在文档注释中的使用方式：例如，如果标签可以在诸如 <b> 或 <i> 的内联元素中使用，taglet 不得返回包含块标签的字符串，像 <h3> 或 <p> 。
块标签
返回的字符串必须是适合定义列表或 <dl> 元素的内容。它通常是一系列 <dt> 和 <dd> 元素对。
参见：

  • 构造方法详细信息

    • StandardDoclet

      public StandardDoclet()
      创建标准 doclet 的实例，用于生成 HTML 格式的文档。

  • 方法详情

    • init

      public void init(Locale  locale, Reporter  reporter)
      从接口 Doclet 复制的描述
      使用给定的locale和错误报告器初始化此 doclet。报告器和 doclet 组件将使用此locale。
      指定者：
      init 在接口 Doclet 中
      参数：
      locale - 要使用的locale
      reporter - 要使用的记者

    • getName

      public String  getName()
      从接口 Doclet 复制的描述
      返回标识 doclet 的名称。名称是一个没有空格的简单标识符，定义在Java 语言规范，第 6.2 节“名称和标识符”。
      指定者：
      getName 在接口 Doclet 中
      返回：
      Doclet 的名称

    • getSupportedOptions

      public Set <? extends Doclet.Option > getSupportedOptions()
      从接口 Doclet 复制的描述
      返回所有支持的选项。
      指定者：
      getSupportedOptions 在接口 Doclet 中
      返回：
      包含所有支持选项的集合，如果没有则为空集

    • getSupportedSourceVersion

      public SourceVersion  getSupportedSourceVersion()
      从接口 Doclet 复制的描述
      返回此 doclet 支持的 Java 编程语言的版本。
      指定者：
      getSupportedSourceVersion 在接口 Doclet 中
      返回：
      此 doclet 支持的语言版本，通常是最新版本

    • run

      public boolean run(DocletEnvironment  docEnv)
      从接口 Doclet 复制的描述
      doclet 的入口点。将按照此方法的指示开始进一步处理。
      指定者：
      run 在接口 Doclet 中
      参数：
      docEnv - 从中可以提取基本信息
      返回：
      成功时为真

    • getLocale

      public Locale  getLocale()
      返回此 doclet 的locale。
      返回：
      此 doclet 的locale
      自从：
      17
      参见：

    • getReporter

      public Reporter  getReporter()
      返回此 doclet 的记者。
      返回：
      这个 doclet 的记者
      自从：
      17
      参见：