Module jdk.javadoc
Package jdk.javadoc.doclet

Class StandardDoclet

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

用户定义的标签

标准doclet支持用户定义的taglets，可用于为文档注释中的用户定义标签生成定制输出。标准doclet调用的标签必须从Taglet.toString返回字符串如下：
内联标签
返回的字符串必须是流内容，或者可能出现在文档主体中的任何有效的HTML代码片段。根据标签在文档注释中的使用方式可能会有额外的约束：例如，如果标签可以在内联元素中使用，如<b>或<i>，则标签不能返回包含块标签的字符串，如<h3>或<p>。
块标签
返回的字符串必须适合定义列表，或<dl>元素。通常会是一系列<dt>和<dd>元素的对。
外部规范

  • Constructor Details

    • StandardDoclet

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

  • Method Details

    • init

      public void init(Locale locale, Reporter reporter)
      从接口复制的描述: Doclet
      使用给定的区域设置和错误报告器初始化此doclet。此区域设置将被报告器和doclet组件使用。
      指定者:
      init 在接口 Doclet
      参数:
      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 - 可从中提取必要信息的对象
      返回:
      成功时返回true

    • getLocale

      public Locale getLocale()
      返回此doclet的区域设置。
      返回:
      此doclet的区域设置
      自版本:
      17
      参见:

    • getReporter

      public Reporter getReporter()
      返回此doclet的报告器。
      返回:
      此doclet的报告器
      自版本:
      17
      参见: