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