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

Interface Doc

    • 方法摘要

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

      • commentText

        String commentText​()
        已过时。
        返回此文档项目的注释文本。 标签已被删除
        结果
        该文档项目的注释文本。
      • tags

        Tag[] tags​()
        已过时。
        返回此文件中的所有标签。
        结果
        包含此Doc文件上所有标签的Tag对象的数组。
      • tags

        Tag[] tags​(String tagname)
        已过时。
        返回本文档中指定的kind的标签。 例如,如果“tagname”的值为“@serial”,则将返回此Doc文件中的所有标签“@serial”。
        参数
        tagname - 要搜索的标签种类的名称。
        结果
        一个包含“kind()”匹配“tagname”的所有标签的Tag的数组。
      • seeTags

        SeeTag[] seeTags​()
        已过时。
        返回此文件中的参见标签。
        结果
        一个包含所有@see标签的SeeTag数组。
      • inlineTags

        Tag[] inlineTags​()
        已过时。
        将注释作为标签数组返回。 包括内联标签(即{@link reference }标签)),但不包括块标签。 纯文本的每个部分被表示为Tagkind “文本”。 内联标签表示为类似“@see”的SeeTag ,名称为“@link”。
        结果
        代表该评论的Tag的数组
      • firstSentenceTags

        Tag[] firstSentenceTags​()
        已过时。
        将注释的第一个句子作为标签数组返回。 包括内联标签(即{@link reference }标签)),但不包括块标签。 纯文本的每个部分被表示为Tagkind “文本”。 内联标签表示为类似“@see”的SeeTag ,名称为“@link”。

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

        结果
        代表评论第一句的Tag s的数组
      • getRawCommentText

        String getRawCommentText​()
        已过时。
        返回评论的完整未处理文本。 标签被包括为文本。 主要用于存储和检索操作,如内部化。
        结果
        评论的完整未经处理的文本。
      • setRawCommentText

        void setRawCommentText​(String rawDocumentation)
        已过时。
        设置注释的完整未处理文本。 标签被包括为文本。 主要用于存储和检索操作,如内部化。
        参数
        rawDocumentation - 包含注释的完整未处理文本的字符串。
      • name

        String name​()
        已过时。
        返回此Doc文件的非限定名称。
        结果
        名字
      • compareTo

        int compareTo​(Object obj)
        已过时。
        将此doc对象与指定的对象进行比较以进行排序。 返回一个负整数,零或正整数,因为该doc对象小于,等于或大于给定对象。

        该方法满足Comparable接口。

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

        boolean isField​()
        已过时。
        这个Doc项目是一个字段(但不是枚举常量)?
        结果
        如果它代表一个字段,则为true
      • isEnumConstant

        boolean isEnumConstant​()
        已过时。
        这个Doc项目是否是一个常量?
        结果
        如果它代表枚举常数,则为true
        从以下版本开始:
        1.5
      • isConstructor

        boolean isConstructor​()
        已过时。
        这个Doc项目是否是构造函数?
        结果
        如果它代表构造函数,则为true
      • isMethod

        boolean isMethod​()
        已过时。
        这个Doc项目是一种方法(但不是构造函数或注释类型元素)?
        结果
        如果它代表一种方法,则为true
      • isAnnotationTypeElement

        boolean isAnnotationTypeElement​()
        已过时。
        这个Doc项目是否是注释类型元素?
        结果
        如果它代表注释类型元素,则为true
        从以下版本开始:
        1.5
      • isInterface

        boolean isInterface​()
        已过时。
        这个Doc项目是否是一个界面(但不是注释类型)?
        结果
        如果它代表一个接口,则为true
      • isException

        boolean isException​()
        已过时。
        这个Doc项目是异常类吗?
        结果
        如果它代表一个异常,则为true
      • isError

        boolean isError​()
        已过时。
        这个Doc项目是错误类吗?
        结果
        如果它代表错误,则为true
      • isEnum

        boolean isEnum​()
        已过时。
        这个Doc项目是枚举类型吗?
        结果
        如果它代表枚举类型,则为true
        从以下版本开始:
        1.5
      • isAnnotationType

        boolean isAnnotationType​()
        已过时。
        这个Doc项目是否是注释类型?
        结果
        如果它代表注释类型,则为true
        从以下版本开始:
        1.5
      • isOrdinaryClass

        boolean isOrdinaryClass​()
        已过时。
        这个文件是ordinary class吗? (即不是接口,注释类型,枚举,异常或错误)?
        结果
        如果它代表一个普通的类,则为true
      • isClass

        boolean isClass​()
        已过时。
        这个Doc项目是class (而不是接口或注释类型)? 这包括普通类,枚举,错误和异常。
        结果
        如果它代表一个类,则为true
      • isIncluded

        boolean isIncluded​()
        已过时。
        如果此文档项目是结果集中的 included ,则返回true。
        结果
        如果此文档项目是结果集中的 included ,则为 true
      • position

        SourcePosition position​()
        已过时。
        返回相应声明的第一行的源位置,如果没有位置可用,则返回null。 默认构造函数返回null,因为源文件中没有位置。
        结果
        相应声明的第一行的来源定位,如果没有位置可用,则为null。 默认构造函数返回null,因为源文件中没有位置。
        从以下版本开始:
        1.4