-
public interface Taglet
由doclet支持的自定义标签的界面,如standard doclet
。 自定义标签用于处理文档注释中的自定义标签。自定义标签必须实现此接口,并且必须具有公共默认构造函数(即,没有参数的公共构造函数),通过该标签,doclet将实例化并注册自定义标签。
- 从以下版本开始:
- 9
-
-
Nested Class Summary
Nested Classes Modifier and Type 接口 描述 static class
Taglet.Location
可以使用标签的位置。
-
方法摘要
所有方法 接口方法 抽象方法 Default Methods Modifier and Type 方法 描述 Set<Taglet.Location>
getAllowedLocations()
返回可以使用标签的位置集合。String
getName()
返回标签的名称。default void
init(DocletEnvironment env, Doclet doclet)
使用给定的doclet环境和doclet初始化此taglet。boolean
isInlineTag()
指示此taglet是否用于内联标签。String
toString(List<? extends DocTree> tags, Element element)
返回要包含在生成的输出中的该标签的一系列实例的字符串表示形式。
-
-
-
方法详细信息
-
getAllowedLocations
Set<Taglet.Location> getAllowedLocations()
返回可以使用标签的位置集合。- 结果
- 可以使用标签的位置集合
-
isInlineTag
boolean isInlineTag()
指示此taglet是否用于内联标签。- 结果
- 如果此taglet用于内联标记,则为true,否则为false
-
getName
String getName()
返回标签的名称。- 结果
- 这个自定义标签的名称。
-
init
default void init(DocletEnvironment env, Doclet doclet)
使用给定的doclet环境和doclet初始化此taglet。
-
-