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

Interface SeeTag

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

    @Deprecated
public interface SeeTag
extends Tag
    表示用户定义的相关文档的交叉引用。 标签可以引用包，类或成员，或者可以包含纯文本。 （纯文本可能是对不在线的东西的引用，例如打印的书，或者是硬编码的HTML链接。）引用可以与注释一起使用，使用{@link}或单独的块注释，使用@see 。 方法name()根据标签返回“@link”（无花括号）或“@see”。 方法kind()为两个标签返回“@see”。

    • 方法详细信息

      • label

        String label​()
        已过时。
        获取@see标签的标签。 如果没有标签，则返回null。 例如：

        @see String#trim() the trim method

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

      • referencedPackage

        PackageDoc referencedPackage​()
        已过时。
        当@see仅引用包时，获取包文档。 返回null如果包不能被发现，或者如果@see参考文献的任何其它元件（类，接口，域，构造，方法）或非元件。 例如：

        @see java.lang

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

      • referencedClassName

        String referencedClassName​()
        已过时。
        获取@see参考的类或接口名称。 如果原始@see标记中指定的名称已经完全限定，或者可以找到类或接口，则该名称是完全限定的; 否则是不合格的。 如果@see仅引用包名称，则返回包名称。 例如：

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

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

      • referencedClass

        ClassDoc referencedClass​()
        已过时。
        获取由@see的类名称引用的类文档。 如果找不到类，返回null。 例如：

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

        返回ClassDoc为java.lang.String 。
        结果
        ClassDoc为 java.lang.String 。

      • referencedMemberName

        String referencedMemberName​()
        已过时。
        获取@see参考的字段，构造函数或方法子字符串。 如果引用是任何其他元素或任何非元素，则返回null。 引用成员类（嵌套类）返回null。 例如：

        @see String#startsWith(String)

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

      • referencedMember

        MemberDoc referencedMember​()
        已过时。
        获取@see引用的字段，构造函数或方法的成员文档。 如果无法找到该成员或者引用是否为任何其他元素或任何非元素，则返回null。 引用成员类（嵌套类）返回null。 例如：

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

        返回MethodDoc为startsWith 。
        结果
        MethodDoc为 startsWith 。