Module  jdk.javadoc
软件包  com.sun.javadoc

Interface Tag

  • All Known Subinterfaces:
    ParamTag ， SeeTag ， SerialFieldTag ， ThrowsTag
    已过时。
    该包装中的声明已被包装jdk.javadoc.doclet的声明所取代。 有关详细信息，请参阅该软件包的文档中的“ 迁移指南” 。 

    @Deprecated
public interface Tag
    代表一个简单的文档标签，如@since，@author，@version。 给定标签（例如“@since 1.2”），保存标签名称（例如“@since”）和标签文本（例如“1.2”）。 具有结构或需要特殊处理的标签由ParamTag（for @param），SeeTag（for @see和）和ThrowsTag（for @ throws）等子类处理。
    另请参见：
    SeeTag ， ParamTag ， ThrowsTag ， SerialFieldTag ， Doc.tags()

    • 方法详细信息

      • name

        String name​()
        已过时。
        返回此标签的名称。 名称是以@return注释中使用的“@”开头的字符串，如@return 。 对于内联标签，例如{@link} ，大括号不是名称的一部分，因此在此示例中，名称将仅为@link 。
        结果
        该标签的名称

      • holder

        Doc holder​()
        已过时。
        返回包含此Tag元素的Doc 。
        结果
        包含此Tag元素的Doc

      • kind

        String kind​()
        已过时。
        返回这个标签的种类。 对于大多数标签， kind() == name() ; 下表列出了某种类型的多个标签的情况： Related Tags kind() name() @throws @throws @throws @exception @see @see @see @link @see @linkplain @serial @serial @serial @serialData
        结果
        这个标签的种类。

      • text

        String text​()
        已过时。
        返回此标签的文本，即超出标签名称的部分。
        结果
        这个标签的文字

      • toString

        String toString​()
        已过时。
        将此对象转换为字符串。
        重写：
        toString在 Object
        结果
        对象的字符串表示形式。

      • inlineTags

        Tag[] inlineTags​()
        已过时。
        有关嵌入式{@link}标签的文档注释，请返回Tag对象的数组。 整个文档注释被分解成由{@link}标记分隔的字符串，其中数组的每个连续元素按照{@link}顺序代表一个字符串或{@link}标记。 每个字符串由名称为“Text”的Tag对象表示，其中text()返回字符串。 每个{@link}标签由名称“@link”和种类“@see”的SeeTag表示。 例如，给出以下注释标签：

        This is a {@link Doc commentlabel} example.

        返回一个Tag对象数组：

        • 标签[0]是一个Tag ，名称为“文本”，文本由“这是一个”
        • 标签[1]是一个SeeTag ，名称为“@link”，引用类为Doc ，标签为“commentlabel”
        • 标签[2]是一个Tag ，名称为“文本”，文本由“示例”组成。
        结果
        标签[]数组的标签
        另请参见：
        ParamTag ， ThrowsTag

      • firstSentenceTags

        Tag[] firstSentenceTags​()
        已过时。
        将注释的第一个句子作为标签数组返回。 包括内联标签（即{@link reference }标签）），但不包括块标签。 纯文本的每一部分表示为类似“文本”的Tag 。 内联代码表示为“@link”类型的SeeTag 。 如果语言环境是英语，则第一句由Java语言规范（第一版）中描述的规则确定：“这句话在第一个句点结束，后面是空白，制表符或行终止符，或者在第一个句子标签“，另外一行将由终止HTML标签的段落和部分终止：<p> </ p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre>或</ pre>。 如果语言环境不是英文，则句子结束将由BreakIterator.getSentenceInstance(Locale)确定。
        结果
        代表评论第一句的Tag个对象的数组

      • position

        SourcePosition position​()
        已过时。
        返回此标签的源位置。
        结果
        该标签的源位置。