接口的使用
com.sun.source.doctree.DocTree

使用 DocTree 的包

包	描述
com.sun.source.doctree	提供将文档注释表示为抽象语法树 (AST) 的接口。
com.sun.source.util	为抽象语法树 (AST) 的操作提供实用程序。
jdk.javadoc.doclet	Doclet API 提供了一个环境，结合语言模型 API 和编译器树 API，允许客户端检查程序和库的源代码级结构，包括嵌入在源代码中的 API 注解。

DocTree 在 com.sun.source.doctree 中的用法

com.sun.source.doctree 中 DocTree 的子接口

修饰符和类型	接口	描述
interface	AttributeTree	HTML 元素或标记中属性的树节点。
interface	AuthorTree	@author 块标记的树节点。
interface	BlockTagTree	用作不同类型块标记的基类的树节点。
interface	CommentTree	嵌入的 HTML 注解。
interface	DeprecatedTree	@deprecated 块标记的树节点。
interface	DocCommentTree	文档注释的顶级表示。
interface	DocRootTree	@docRoot 内联标记的树节点。
interface	DocTypeTree	doctype 声明的树节点。
interface	EndElementTree	HTML 元素末尾的树节点。
interface	EntityTree	HTML 实体的树节点。
interface	ErroneousTree	代表格式错误文本的树节点。
interface	HiddenTree	@hidden 块标记的树节点。
interface	IdentifierTree	文档注释中的标识符。
interface	IndexTree	@index 内联标记的树节点。
interface	InheritDocTree	@inheritDoc 内联标记的树节点。
interface	InlineTagTree	用作不同类型内联标记的基类的树节点。
interface	LinkTree	@link 或 @linkplain 内联标记的树节点。
interface	LiteralTree	@literal 或 @code 内联标记的树节点。
interface	ParamTree	@param 块标记的树节点。
interface	ProvidesTree	@provides 块标记的树节点。
interface	ReferenceTree	用于引用 Java 语言元素的树节点。
interface	ReturnTree	@return 块标记的树节点。
interface	SeeTree	@see 块标记的树节点。
interface	SerialDataTree	@serialData 块标记的树节点。
interface	SerialFieldTree	@serialField 块标记的树节点。
interface	SerialTree	@serial 块标记的树节点。
interface	SinceTree	@since 块标记的树节点。
interface	SnippetTree	@snippet 内联标记的树节点。
interface	SpecTree	@spec 块标记的树节点。
interface	StartElementTree	HTML 元素开始的树节点。
interface	SummaryTree	@summary 内联标记的树节点。
interface	SystemPropertyTree	@systemProperty 内联标记的树节点。
interface	TextTree	纯文本的树节点。
interface	ThrowsTree	@exception 或 @throws 块标记的树节点。
interface	UnknownBlockTagTree	无法识别的块标记的树节点。
interface	UnknownInlineTagTree	无法识别的内联标记的树节点。
interface	UsesTree	@uses 块标记的树节点。
interface	ValueTree	@value 内联标记的树节点。
interface	VersionTree	@version 块标记的树节点。

com.sun.source.doctree 中返回 DocTree 的方法

修饰符和类型	方法	描述
DocTree	IndexTree.getSearchTerm()	返回指定的搜索词。

返回类型中包含 DocTree 类型参数的 com.sun.source.doctree 中的方法

修饰符和类型	方法	描述
List<? extends DocTree>	SnippetTree.getAttributes()	返回 @snippet 标签的属性列表。
List<? extends DocTree>	StartElementTree.getAttributes()	返回此元素定义的任何属性。
List<? extends DocTree>	DocCommentTree.getBlockTags()	返回文档注释的块标签。
List<? extends DocTree>	DeprecatedTree.getBody()	返回解释项目为何被弃用的描述。
List<? extends DocTree>	DocCommentTree.getBody()	返回文档注释的正文，出现在第一句话之后和任何块标记之前。
List<? extends DocTree>	HiddenTree.getBody()	返回解释项目隐藏原因的说明。
List<? extends DocTree>	SinceTree.getBody()	返回说明正在记录的项目的可用性的文本。
List<? extends DocTree>	VersionTree.getBody()	返回标签的主体。
List<? extends DocTree>	UnknownBlockTagTree.getContent()	返回无法识别的块标记的内容。
List<? extends DocTree>	UnknownInlineTagTree.getContent()	返回无法识别的内联标签的内容。
List<? extends DocTree>	IndexTree.getDescription()	返回说明（如果有）。
List<? extends DocTree>	ParamTree.getDescription()	返回参数的描述。
List<? extends DocTree>	ProvidesTree.getDescription()	返回模块提供的服务类型的描述。
List<? extends DocTree>	ReturnTree.getDescription()	返回方法返回值的描述。
List<? extends DocTree>	SerialDataTree.getDescription()	返回串行数据的描述。
List<? extends DocTree>	SerialFieldTree.getDescription()	返回序列字段的描述。
List<? extends DocTree>	SerialTree.getDescription()	返回字段的描述，或单词“include”或“exclude”。
List<? extends DocTree>	ThrowsTree.getDescription()	返回可能引发异常的原因的描述。
List<? extends DocTree>	UsesTree.getDescription()	返回模块内服务类型使用的描述。
List<? extends DocTree>	DocCommentTree.getFirstSentence()	返回文档注释的第一句。
default List<? extends DocTree>	DocCommentTree.getFullBody()	返回文档注释的整个主体，出现在任何块标记之前，包括第一句话。
List<? extends DocTree>	LinkTree.getLabel()	返回链接的标签（如果有）。
List<? extends DocTree>	AuthorTree.getName()	返回作者的姓名。
default List<? extends DocTree>	DocCommentTree.getPostamble()	返回包含文档注释内容之后的内容（如果有）的树列表。
default List<? extends DocTree>	DocCommentTree.getPreamble()	返回包含文档注释内容之前的内容（如果有）的树列表。
List<? extends DocTree>	SeeTree.getReference()	返回引用。
List<? extends DocTree>	SummaryTree.getSummary()	返回摘要或评论的第一行。
List<? extends DocTree>	SpecTree.getTitle()	返回标题。
List<? extends DocTree>	AttributeTree.getValue()	返回属性的值，如果 这种属性 是 EMPTY 则返回 null。

com.sun.source.doctree 中的方法，参数类型为 DocTree

修饰符和类型	方法	描述
R	DocTreeVisitor.visitOther(DocTree node, P p)	访问未知类型的 DocTree 节点。

DocTree 在 com.sun.source.util 中的用法

com.sun.source.util 中返回 DocTree 的方法

修饰符和类型	方法	描述
DocTree	DocTreePath.getLeaf()	返回此路径的叶节点。

返回类型中包含 DocTree 类型参数的 com.sun.source.util 中的方法

修饰符和类型	方法	描述
List<DocTree>	DocTreeFactory.getFirstSentence(List<? extends DocTree> list)	获取内容列表中包含的第一句话。
abstract List<DocTree>	DocTrees.getFirstSentence(List<? extends DocTree> list)	返回表示评论第一句的 DocTree 列表。
Iterator<DocTree>	DocTreePath.iterator()

com.sun.source.util 中的方法，参数类型为 DocTree

修饰符和类型	方法	描述
protected R	SimpleDocTreeVisitor.defaultAction(DocTree node, P p)	默认操作，由所有未重写的访问方法使用。
long	DocSourcePositions.getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)	返回文件中注释中树的结束位置。
static DocTreePath	DocTreePath.getPath(DocTreePath path, DocTree target)	返回由 DocTreePath 对象标识的子树中树节点的文档树路径，如果未找到该节点，则返回 null。
static DocTreePath	DocTreePath.getPath(TreePath treePath, DocCommentTree doc, DocTree target)	返回编译单元内树节点的文档树路径，如果未找到该节点，则返回 null。
long	DocSourcePositions.getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)	返回文件中注释中树的起始位置。
IndexTree	DocTreeFactory.newIndexTree(DocTree term, List<? extends DocTree> description)	创建一个新的 IndexTree 对象，代表一个 {@index } 标签。
abstract void	DocTrees.printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)	在提供的编译单元内的树位置打印指定类型的消息。
R	DocTreePathScanner.scan(DocTree tree, P p)	扫描单个节点。
R	DocTreeScanner.scan(DocTree node, P p)	扫描单个节点。
final R	SimpleDocTreeVisitor.visit(DocTree node, P p)	调用特定于节点类型的适当访问方法。
R	DocTreeScanner.visitOther(DocTree node, P p)	访问未知类型的 DocTree 节点。
R	SimpleDocTreeVisitor.visitOther(DocTree node, P p)	访问未知类型的 DocTree 节点。

com.sun.source.util 中的方法参数，类型参数为 DocTree

修饰符和类型	方法	描述
List<DocTree>	DocTreeFactory.getFirstSentence(List<? extends DocTree> list)	获取内容列表中包含的第一句话。
abstract List<DocTree>	DocTrees.getFirstSentence(List<? extends DocTree> list)	返回表示评论第一句的 DocTree 列表。
AttributeTree	DocTreeFactory.newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value)	创建一个新的 AttributeTree 对象，以表示 HTML 元素或标记中的属性。
AuthorTree	DocTreeFactory.newAuthorTree(List<? extends DocTree> name)	创建一个新的 AuthorTree 对象，代表一个 @author 标签。
DeprecatedTree	DocTreeFactory.newDeprecatedTree(List<? extends DocTree> text)	创建一个新的 DeprecatedTree 对象，代表一个 @deprecated 标签。
DocCommentTree	DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)	创建一个新的 DocCommentTree 对象，代表一个完整的文档评论。
DocCommentTree	DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble)	创建一个新的 DocCommentTree 对象，代表整个文档评论。
ThrowsTree	DocTreeFactory.newExceptionTree(ReferenceTree name, List<? extends DocTree> description)	创建一个新的 ThrowsTree 对象，代表一个 @exception 标签。
HiddenTree	DocTreeFactory.newHiddenTree(List<? extends DocTree> text)	创建一个新的 HiddenTree 对象，代表一个 @hidden 标签。
IndexTree	DocTreeFactory.newIndexTree(DocTree term, List<? extends DocTree> description)	创建一个新的 IndexTree 对象，代表一个 {@index } 标签。
LinkTree	DocTreeFactory.newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)	创建一个新的 LinkTree 对象，代表一个 {@linkplain } 标签。
LinkTree	DocTreeFactory.newLinkTree(ReferenceTree ref, List<? extends DocTree> label)	创建一个新的 LinkTree 对象，代表一个 {@link } 标签。
ParamTree	DocTreeFactory.newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)	创建一个新的 ParamTree 对象，代表一个 @param 标签。
ProvidesTree	DocTreeFactory.newProvidesTree(ReferenceTree name, List<? extends DocTree> description)	创建一个新的 ProvidesTree 对象，代表一个 @provides 标签。
default ReturnTree	DocTreeFactory.newReturnTree(boolean isInline, List<? extends DocTree> description)	创建一个新的 ReturnTree 对象，以表示 @return 标签或 {@return} 标签。
ReturnTree	DocTreeFactory.newReturnTree(List<? extends DocTree> description)	创建一个新的 ReturnTree 对象，代表一个 @return 标签。
SeeTree	DocTreeFactory.newSeeTree(List<? extends DocTree> reference)	创建一个新的 SeeTree 对象，代表一个 @see 标签。
SerialDataTree	DocTreeFactory.newSerialDataTree(List<? extends DocTree> description)	创建一个新的 SerialDataTree 对象，代表一个 @serialData 标签。
SerialFieldTree	DocTreeFactory.newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)	创建一个新的 SerialFieldTree 对象，代表一个 @serialField 标签。
SerialTree	DocTreeFactory.newSerialTree(List<? extends DocTree> description)	创建一个新的 SerialTree 对象，代表一个 @serial 标签。
SinceTree	DocTreeFactory.newSinceTree(List<? extends DocTree> text)	创建一个新的 SinceTree 对象，代表一个 @since 标签。
SnippetTree	DocTreeFactory.newSnippetTree(List<? extends DocTree> attributes, TextTree text)	创建一个新的 SnippetTree 对象，代表一个 {@snippet } 标签。
SpecTree	DocTreeFactory.newSpecTree(TextTree url, List<? extends DocTree> title)	创建一个新的 SpecTree 对象，代表一个 @spec 标签。
StartElementTree	DocTreeFactory.newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)	创建一个新的 StartElementTree 对象，代表 HTML 元素的开始。
default SummaryTree	DocTreeFactory.newSummaryTree(List<? extends DocTree> summary)	创建一个新的 SummaryTree 对象，代表一个 {@summary } 标签。
ThrowsTree	DocTreeFactory.newThrowsTree(ReferenceTree name, List<? extends DocTree> description)	创建一个新的 ThrowsTree 对象，代表一个 @throws 标签。
UnknownBlockTagTree	DocTreeFactory.newUnknownBlockTagTree(Name name, List<? extends DocTree> content)	创建一个新的 UnknownBlockTagTree 对象，以表示无法识别的块标记。
UnknownInlineTagTree	DocTreeFactory.newUnknownInlineTagTree(Name name, List<? extends DocTree> content)	创建一个新的 UnknownInlineTagTree 对象，以表示无法识别的内联标签。
UsesTree	DocTreeFactory.newUsesTree(ReferenceTree name, List<? extends DocTree> description)	创建一个新的 UsesTree 对象，代表一个 @uses 标签。
VersionTree	DocTreeFactory.newVersionTree(List<? extends DocTree> text)	创建一个新的 VersionTree 对象，代表一个 {@version } 标签。
R	DocTreeScanner.scan(Iterable<? extends DocTree> nodes, P p)	扫描一系列节点。
final R	SimpleDocTreeVisitor.visit(Iterable<? extends DocTree> nodes, P p)	对一系列节点中的每一个调用适当的访问方法。

com.sun.source.util 中的构造函数，参数类型为 DocTree

修饰符	构造方法	描述
	DocTreePath(DocTreePath p, DocTree t)	为子节点创建一个 DocTreePath。

DocTree 在 jdk.javadoc.doclet 中的用法

jdk.javadoc.doclet 中的方法参数，类型参数为 DocTree

修饰符和类型	方法	描述
String	Taglet.toString(List<? extends DocTree> tags, Element element)	返回要包含在生成的输出中的此标记的一系列实例的字符串表示形式。