Module  jdk.javadoc
软件包  jdk.javadoc.doclet

Interface Taglet



  • public interface Taglet
    由doclet支持的自定义标签的界面,如standard doclet 自定义标签用于处理文档注释中的自定义标签。

    自定义标签必须实现此接口,并且必须具有公共默认构造函数(即,没有参数的公共构造函数),通过该标签,doclet将实例化并注册自定义标签。

    从以下版本开始:
    9
    • 方法详细信息

      • 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。
        API Note:
        如果需要,环境可以用于访问elementstypes实用程序类。
        实现要求:
        这个实现什么都不做。
        参数
        env - doclet和taglet正在运行的环境
        doclet - 实例化此taglet的doclet
      • toString

        String toString​(List<? extends DocTree> tags,
                        Element element)
        返回要包含在生成的输出中的该标签的一系列实例的字符串表示形式。 如果这个taglet是inline标签,那么每个标签的每个实例都会被调用一次,每次都有一个单例列表。 否则,如果此标记是块标记,则每个注释将调用一次标记,并在注释中列出所有标记的实例。
        参数
        tags - 此标签的实例列表
        element - 封闭注释所属的元素
        结果
        要包括在生成的输出中的标签的字符串表示