Doclet - Java 11中文版 - API参考文档

API Reference Document

所有已知实现类：

StandardDoclet
```
public interface Doclet
```
用户doclet必须实现此接口，如package description中所述。 Doclet的每个实现都必须提供一个公共的无参构造函数，供工具用来实例化doclet。工具基础结构将与实现此接口的类交互，如下所示：
1. 该工具将使用doclet类的no-arg构造函数创建doclet的实例。
2. 接下来，该工具使用适当的区域设置和报告器调用init方法。
3. 之后，该工具调用getSupportedOptions和getSupportedSourceVersion 。这些方法只调用一次。
4. 在适当的情况下，该工具调用doclet对象上的run方法，为其提供DocletEnvironment对象，doclet可以从中确定要包含在文档中的元素。
如果在没有遵循上述协议的情况下创建和使用doclet对象，则此接口规范不会定义doclet的行为。

要启动doclet，请在javadoc工具命令行上传递-doclet然后传入入口点类的完全限定名称（即此接口的实现）。
从以下版本开始：

9

嵌套类汇总

嵌套类
变量和类型	接口	描述
`static interface`	`Doclet.Option`	Doclet使用的选项名称，别名，参数和描述的封装。

方法摘要

所有方法实例方法抽象方法
变量和类型	方法	描述
`String`	`getName()`	返回标识doclet的名称。
`Set<? extends Doclet.Option>`	`getSupportedOptions()`	返回所有支持的选项。
`SourceVersion`	`getSupportedSourceVersion()`	返回此doclet支持的Java编程语言的版本。
`void`	`init(Locale locale, Reporter reporter)`	使用给定的语言环境和错误报告器初始化此doclet。
`boolean`	`run(DocletEnvironment environment)`	doclet的入口点。

- 方法详细信息
  - init
```
void init(Locale locale,
          Reporter reporter)
```
    使用给定的语言环境和错误报告器初始化此doclet。记录器和doclet组件将使用此语言环境。
    
    参数
    
    locale - 要使用的语言环境
    
    reporter - 记者 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 - 从中可以提取基本信息
    
    结果
    
    成功的真实