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

Interface Doc

    • 方法摘要

      所有方法  实例方法 抽象方法  弃用的方法 
      变量和类型 方法 描述
      String commentText()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      返回此doc项的注释文本。
      int compareTo​(Object obj)
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      将此doc对象与指定的对象进行比较以进行排序。
      Tag[] firstSentenceTags()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      将注释的第一句作为标记数组返回。
      String getRawCommentText()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      返回注释的完整未处理文本。
      Tag[] inlineTags()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      将注释作为标记数组返回。
      boolean isAnnotationType()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      此Doc项是注释类型吗?
      boolean isAnnotationTypeElement()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      此Doc项是注释类型元素吗?
      boolean isClass()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      此Doc项目是 class (而不是界面或注释类型)?
      boolean isConstructor()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      这个Doc项是构造函数吗?
      boolean isEnum()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      此Doc项是枚举类型吗?
      boolean isEnumConstant()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      这个Doc项是枚举常量吗?
      boolean isError()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      此Doc项是错误类吗?
      boolean isException()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      这个Doc项是异常类吗?
      boolean isField()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      此Doc项是字段(但不是枚举常量)吗?
      boolean isIncluded()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      如果此Doc项在结果集中为 included ,则返回true。
      boolean isInterface()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      此Doc项是接口(但不是注释类型)吗?
      boolean isMethod()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      这个Doc项是一个方法(但不是构造函数或注释类型元素)吗?
      boolean isOrdinaryClass()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      这个Doc项目是 ordinary class吗?
      String name()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      返回此Doc项的非限定名称。
      SourcePosition position()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      返回相应声明的第一行的源位置,如果没有可用位置,则返回null。
      SeeTag[] seeTags()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      返回此Doc项目中的see also标签。
      void setRawCommentText​(String rawDocumentation)
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      设置注释的完整未处理文本。
      Tag[] tags()
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      返回此Doc项目中的所有标记。
      Tag[] tags​(String tagname)
      不推荐使用,要删除:此API元素将在以后的版本中删除。
      返回此Doc项目中指定的 kind的标记。
    • 方法详细信息

      • commentText

        String commentText()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回此doc项的注释文本。 标签已被删除。
        结果
        此doc项的注释文本。
      • tags

        Tag[] tags()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回此Doc项目中的所有标记。
        结果
        包含此Doc项目上所有标记的Tag对象的数组。
      • tags

        Tag[] tags​(String tagname)
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回此Doc项目中指定的kind的标记。 例如,如果'tagname'的值为“@serial”,则将返回此Doc项中所有类型为“@serial”的标记。
        参数
        tagname - 要搜索的标记类型的名称。
        结果
        一个Tag数组,包含'kind()'匹配'tagname'的所有标签。
      • seeTags

        SeeTag[] seeTags()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回此Doc项目中的see also标签。
        结果
        包含所有@see标记的SeeTag数组。
      • inlineTags

        Tag[] inlineTags()
        Deprecated, for removal: This API element is subject to removal in a future version.
        将注释作为标记数组返回。 包括内联标记(即{@link reference }标记),但不包括块标记。 纯文本的每个部分表示为Tagkind “文本”。 内联标签表示为类型为“@see”的SeeTag ,名称为“@link”。
        结果
        表示评论的Tag的数组
      • firstSentenceTags

        Tag[] firstSentenceTags()
        Deprecated, for removal: This API element is subject to removal in a future version.
        将注释的第一句作为标记数组返回。 包括内联标记(即{@link reference }标记),但不包括块标记。 纯文本的每个部分被表示为Tagkind “文本”。 内联标签表示为SeeTag ,类型为“@see”,名称为“@link”。

        如果语言环境是英语,则第一句话由Java语言规范(第一版)中描述的规则确定:“此句在第一个句点结束,后面是空格,制表符或行终止符或第一个句点另外,一行将被块HTML标签终止:<p> </ p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre>或</预>。 如果区域设置不是英语,则句末结束将由BreakIterator.getSentenceInstance(Locale)确定。

        结果
        一个Tag的数组,代表评论的第一句话
      • getRawCommentText

        String getRawCommentText()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回注释的完整未处理文本。 标签包含在文本中。 主要用于内部化等存储和检索操作。
        结果
        评论的完整未处理文本。
      • setRawCommentText

        void setRawCommentText​(String rawDocumentation)
        Deprecated, for removal: This API element is subject to removal in a future version.
        设置注释的完整未处理文本。 标签包含在文本中。 主要用于内部化等存储和检索操作。
        参数
        rawDocumentation - 包含注释的完整未处理文本的字符串。
      • name

        String name()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回此Doc项的非限定名称。
        结果
        名字
      • compareTo

        int compareTo​(Object obj)
        Deprecated, for removal: This API element is subject to removal in a future version.
        将此doc对象与指定的对象进行比较以进行排序。 返回负整数,零或正整数,因为此doc对象小于,等于或大于给定对象。

        该方法满足Comparable接口。

        Specified by:
        compareTo接口 Comparable<Object>
        参数
        obj - 待比较的 Object
        结果
        一个负整数,零或正整数,因为此Object小于,等于或大于给定的Object。
        异常
        ClassCastException - 指定的Object类型阻止将其与此Object进行比较。
      • isField

        boolean isField()
        Deprecated, for removal: This API element is subject to removal in a future version.
        此Doc项是字段(但不是枚举常量)吗?
        结果
        如果它代表一个字段,则为true
      • isEnumConstant

        boolean isEnumConstant()
        Deprecated, for removal: This API element is subject to removal in a future version.
        这个Doc项是枚举常量吗?
        结果
        如果它表示枚举常量,则返回true
        从以下版本开始:
        1.5
      • isConstructor

        boolean isConstructor()
        Deprecated, for removal: This API element is subject to removal in a future version.
        这个Doc项是构造函数吗?
        结果
        如果它表示构造函数,则返回true
      • isMethod

        boolean isMethod()
        Deprecated, for removal: This API element is subject to removal in a future version.
        这个Doc项是一个方法(但不是构造函数或注释类型元素)吗?
        结果
        如果它表示方法,则为true
      • isAnnotationTypeElement

        boolean isAnnotationTypeElement()
        Deprecated, for removal: This API element is subject to removal in a future version.
        此Doc项是注释类型元素吗?
        结果
        如果它表示注释类型元素,则返回true
        从以下版本开始:
        1.5
      • isInterface

        boolean isInterface()
        Deprecated, for removal: This API element is subject to removal in a future version.
        此Doc项是接口(但不是注释类型)吗?
        结果
        如果它表示接口,则为true
      • isException

        boolean isException()
        Deprecated, for removal: This API element is subject to removal in a future version.
        这个Doc项是异常类吗?
        结果
        如果它表示异常,则为true
      • isError

        boolean isError()
        Deprecated, for removal: This API element is subject to removal in a future version.
        此Doc项是错误类吗?
        结果
        如果它表示错误,则为true
      • isEnum

        boolean isEnum()
        Deprecated, for removal: This API element is subject to removal in a future version.
        此Doc项是枚举类型吗?
        结果
        如果它表示枚举类型,则为true
        从以下版本开始:
        1.5
      • isAnnotationType

        boolean isAnnotationType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        此Doc项是注释类型吗?
        结果
        如果它表示注释类型,则返回true
        从以下版本开始:
        1.5
      • isOrdinaryClass

        boolean isOrdinaryClass()
        Deprecated, for removal: This API element is subject to removal in a future version.
        这个Doc项目是ordinary class吗? (即不是接口,注释类型,枚举,异常或错误)?
        结果
        如果它代表一个普通的类,则为true
      • isClass

        boolean isClass()
        Deprecated, for removal: This API element is subject to removal in a future version.
        此Doc项是class (而不是接口或注释类型)? 这包括普通类,枚举,错误和例外。
        结果
        如果它代表一个类,则为true
      • isIncluded

        boolean isIncluded()
        Deprecated, for removal: This API element is subject to removal in a future version.
        如果此Doc项在结果集中为 included ,则返回true。
        结果
        如果此Doc项在结果集中为 included ,则为 true
      • position

        SourcePosition position()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回相应声明的第一行的源位置,如果没有可用位置,则返回null。 默认构造函数返回null,因为它在源文件中没有位置。
        结果
        相应声明的第一行的源positino,如果没有可用的位置,则为null。 默认构造函数返回null,因为它在源文件中没有位置。
        从以下版本开始:
        1.4