Module jdk.javadoc

Package jdk.javadoc.doclet

Interface Taglet

       public interface Taglet
      

自定义标签支持的接口，由标准文档生成器等doclet支持。自定义标签用于处理文档注释中的自定义标签；自定义标签可以单独实例化为“块标签”，出现在注释末尾，或者“内联标签”，可以出现在文档注释的主体内。

每个标签的实现必须提供一个公共无参数构造函数，以便doclet实例化标签。doclet将与实现此接口的类交互如下：

1. doclet将使用标签类的无参数构造函数创建标签的实例。
2. 接下来，doclet使用适当的环境和doclet调用init方法。
3. 之后，doclet调用getName、getAllowedLocations和isInlineTag，以确定标签支持的特性。
4. 根据需要，doclet在标签对象上调用toString方法，给定标签列表和标签所属元素的元素，从中标签可以确定要包含在文档中的字符串。doclet通常会指定返回的字符串内容的任何要求。

如果创建并使用标签对象而不遵循上述协议，则此接口规范不定义标签的行为。

API 注意：

标签通常设计为与特定doclet一起使用。

自 JDK 版本：

9

参见：

• 标准文档生成器的用户定义标签

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Taglet.Location	标签可用的位置类型。

Method Summary

Modifier and Type	Method	Description
Set<Taglet.Location>	getAllowedLocations()	返回块标签支持的位置集。
String	getName()	返回此标签支持的标签的名称。
default void	init(DocletEnvironment env, Doclet doclet)	使用给定的doclet环境和doclet初始化此标签。
default boolean	isBlockTag()	指示此标签是否支持块标签。
boolean	isInlineTag()	指示此标签是否支持内联标签。
String	toString(List<? extends DocTree> tags, Element element)	返回要包含在生成的输出中的一系列此标签实例的字符串表示形式。

Method Details

getAllowedLocations

             Set<Taglet.Location> getAllowedLocations()
            

返回块标签支持的位置集。

返回：

支持块标签的位置集

isInlineTag

             boolean isInlineTag()
            

指示此标签是否支持内联标签。

返回：

如果此标签支持内联标签，则为true

isBlockTag

             default boolean isBlockTag()
            

指示此标签是否支持块标签。

实现要求：

此实现返回与isInlineTag相反的结果。

返回：

如果此标签支持块标签，则为true

getName

             String getName()
            

返回此标签支持的标签的名称。

返回：

此标签的名称

init

             default void init(DocletEnvironment env, Doclet doclet)
            

使用给定的doclet环境和doclet初始化此标签。

API 注意：

如果需要，可以使用环境访问实用程序类elements和types。

实现要求：

此实现不执行任何操作。

参数：

env - doclet和标签所在的环境

doclet - 实例化此标签的doclet

toString

             String toString(List<? extends DocTree> tags, Element element)
            

返回要包含在生成的输出中的一系列此标签实例的字符串表示形式。

如果此标签支持内联标签，每次调用时将为内联标签的每个实例调用一次，每次使用单例列表。如果此标签支持块标签，将为包含块标签实例的每个注释调用一次，其中包含该注释中所有块标签实例的列表。

参数：

tags - 此标签的实例列表

element - 封闭注释所属的元素

返回：

要包含在生成的输出中的标签的字符串表示形式

参见：

• 标准文档生成器的用户定义标签