模块  jdk.javadoc
软件包  com.sun.javadoc

Interface SeeTag

  • All Superinterfaces:
    Tag 
    @Deprecated(since="9",
            forRemoval=true)
public interface SeeTag
extends Tag
    Deprecated, for removal: This API element is subject to removal in a future version.
    The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.
    表示用户定义的相关文档的交叉引用。 标记可以引用包，类或成员，也可以包含纯文本。 （纯文本可能是对非在线内容的引用，例如印刷书籍，或者是硬编码的HTML链接。）引用可以使用{@link}与评论内联，也可以使用单独的块注释，使用@see 。 方法name()返回“@link”（无大括号）或“@see”，具体取决于标记。 方法kind()为两个标记返回“@see”。

    • 方法详细信息

      • label

        String label()
        Deprecated, for removal: This API element is subject to removal in a future version.
        获取@see标签的标签。 如果没有标签，则返回null。 例如，对于：

        @see String#trim() the trim method

        返回“修剪方法”。
        结果
        “修剪方法”。

      • referencedPackage

        PackageDoc referencedPackage()
        Deprecated, for removal: This API element is subject to removal in a future version.
        当@see仅引用包时获取包文档。 如果无法找到包，或者如果@see引用任何其他元素（类，接口，字段，构造函数，方法）或非元素，则返回null。 例如，对于：

        @see java.lang

        返回PackageDoc获取java.lang 。
        结果
        PackageDoc为 java.lang 。

      • referencedClassName

        String referencedClassName()
        Deprecated, for removal: This API element is subject to removal in a future version.
        获取@see引用的类或接口名称。 如果原始@see标记中指定的名称是完全限定的，或者可以找到类或接口，则该名称是完全限定的; 否则它是不合格的。 如果@see仅引用包名称，则返回包名称。 例如，对于：

        @see String#valueOf(java.lang.Object)

        返回“java.lang.String”。 对于“ @see java.lang ”，返回“java.lang”。 如果@see引用非元素，则返回null，例如@see <a href="java.sun.com"> 。
        结果
        如果 @see引用非元素，例如 @see <a href="java.sun.com"> ，则 @see null。

      • referencedClass

        ClassDoc referencedClass()
        Deprecated, for removal: This API element is subject to removal in a future version.
        获取@see的类名部分引用的类doc。 如果找不到类，则返回null。 例如，对于：

        @see String#valueOf(java.lang.Object)

        返回ClassDoc获取java.lang.String 。
        结果
        ClassDoc代表 java.lang.String 。

      • referencedMemberName

        String referencedMemberName()
        Deprecated, for removal: This API element is subject to removal in a future version.
        获取@see引用的字段，构造函数或方法子字符串。 如果引用是对任何其他元素或任何非元素，则返回null。 对成员类（嵌套类）的引用返回null。 例如，对于：

        @see String#startsWith(String)

        return“startsWith（String）”。
        结果
        “startsWith（字符串）”。

      • referencedMember

        MemberDoc referencedMember()
        Deprecated, for removal: This API element is subject to removal in a future version.
        获取@see引用的字段，构造函数或方法的成员文档。 如果无法找到成员或者引用是否属于任何其他元素或任何非元素，则返回null。 对成员类（嵌套类）的引用返回null。 例如，对于：

        @see String#startsWith(java.lang.String)

        返回MethodDoc获取startsWith 。
        结果
        MethodDoc代表 startsWith 。