模块 jdk.compiler
包 com.sun.source.doctree

接口 DocCommentTree

所有父级接口：
DocTree
public interface DocCommentTree extends DocTree
文档注释的顶级表示。 
  first-sentence body block-tags
自从：
1.8

  • 内部类总结

    在接口 com.sun.source.doctree.DocTree 中声明的嵌套类/接口

    DocTree.Kind

  • 方法总结

    修饰符和类型
    方法
    描述
    List<? extends DocTree>
    getBlockTags()
    返回文档注释的块标签。
    List<? extends DocTree>
    getBody()
    返回文档注释的正文，出现在第一句话之后和任何块标记之前。
    List<? extends DocTree>
    getFirstSentence()
    返回文档注释的第一句。
    default List<? extends DocTree>
    getFullBody()
    返回文档注释的整个主体，出现在任何块标记之前，包括第一句话。
    default List<? extends DocTree>
    getPostamble()
    返回包含文档注释内容之后的内容（如果有）的树列表。
    default List<? extends DocTree>
    getPreamble()
    返回包含文档注释内容之前的内容（如果有）的树列表。

    在接口 com.sun.source.doctree.DocTree 中声明的方法

    accept, getKind

  • 方法详情

    • getFirstSentence

      List <? extends DocTree > getFirstSentence()
      返回文档注释的第一句。
      返回：
      文档注释的第一句

    • getFullBody

      default List <? extends DocTree > getFullBody()
      返回文档注释的整个主体，出现在任何块标记之前，包括第一句话。
      返回：
      文档正文注释第一句包括在内
      自从：
      9

    • getBody

      List <? extends DocTree > getBody()
      返回文档注释的正文，出现在第一句话之后和任何块标记之前。
      返回：
      文档注释的主体

    • getBlockTags

      List <? extends DocTree > getBlockTags()
      返回文档注释的块标签。
      返回：
      文档注释的块标记

    • getPreamble

      default List <? extends DocTree > getPreamble()
      返回包含文档注释内容之前的内容（如果有）的树列表。当 DocCommentTree 已从 Java 源文件中的文档注释中读取时，列表将为空。当 DocCommentTree 已从 HTML 文件中读取时，这表示从文件开头到并包括 <body> 标记的内容。
      实现要求：
      此实现返回一个空列表。
      返回：
      树的列表
      自从：
      10

    • getPostamble

      default List <? extends DocTree > getPostamble()
      返回包含文档注释内容之后的内容（如果有）的树列表。当 DocCommentTree 已从 Java 源文件中的文档注释中读取时，列表将为空。当 DocCommentTree 已从 HTML 文件中读取时，这表示从 </body> 标记到文件末尾的内容。
      实现要求：
      此实现返回一个空列表。
      返回：
      树的列表
      自从：
      10