Module jdk.compiler
Package com.sun.source.doctree

Interface DocCommentTree

所有超级接口:
DocTree
public interface DocCommentTree extends DocTree
文档注释的顶层表示。 
    第一句正文块标签
自JDK版本:
1.8

  • Nested Class Summary

    Nested classes/interfaces declared in interface com.sun.source.doctree.DocTree

    DocTree.Kind

  • Method Summary

    Modifier and Type
    Method
    Description
    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()
    返回包含文档注释内容（如果有）的树列表，位于文档注释内容之前。

    Methods declared in interface com.sun.source.doctree.DocTree

    accept, getKind

  • Method Details

    • getFirstSentence

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

    • getFullBody

      default List<? extends DocTree> getFullBody()
      返回文档注释的整个正文，出现在任何块标签之前，包括第一句。
      返回:
      文档注释的正文，包括第一句
      自JDK版本:
      9

    • getBody

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

    • getBlockTags

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

    • getPreamble

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

    • getPostamble

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