模块  jdk.javadoc
软件包  jdk.javadoc.doclet

Interface Taglet


  • public interface Taglet
    doclet支持的自定义标记的接口,例如standard doclet 自定义标记用于处理文档注释中的自定义标记。

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

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

      • getAllowedLocations

        Set<Taglet.Location> getAllowedLocations()
        返回可以使用标记的位置集。
        结果
        可以使用标签的位置集
      • isInlineTag

        boolean isInlineTag()
        指示此标记是否用于内联标记。
        结果
        如果此标记用于内联标记,则为true,否则为false
      • getName

        String getName()
        返回标记的名称。
        结果
        此自定义标记的名称。
      • init

        default void init​(DocletEnvironment env,
                          Doclet doclet)
        使用给定的doclet环境和doclet初始化此taglet。
        API Note:
        如果需要,可以使用该环境访问elementstypes实用程序类。
        实现要求:
        这种实现什么都不做。
        参数
        env - 运行doclet和taglet的环境
        doclet - 实例化此标记的doclet
      • toString

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