接口的使用
com.sun.source.doctree.DocTree
使用 DocTree 的包
包
描述
提供将文档注释表示为抽象语法树 (AST) 的接口。
为抽象语法树 (AST) 的操作提供实用程序。
Doclet API 提供了一个环境,结合语言模型 API 和编译器树 API,允许客户端检查程序和库的源代码级结构,包括嵌入在源代码中的 API 注解。
-
DocTree 在 com.sun.source.doctree 中的用法
com.sun.source.doctree 中 DocTree 的子接口修饰符和类型接口描述interfaceHTML 元素或标记中属性的树节点。interface@author块标记的树节点。interface用作不同类型块标记的基类的树节点。interface嵌入的 HTML 注解。interface@deprecated块标记的树节点。interface文档注释的顶级表示。interface@docRoot内联标记的树节点。interfacedoctype声明的树节点。interfaceHTML 元素末尾的树节点。interfaceHTML 实体的树节点。interface代表格式错误文本的树节点。interface@hidden块标记的树节点。interface文档注释中的标识符。interface@index内联标记的树节点。interface@inheritDoc内联标记的树节点。interface用作不同类型内联标记的基类的树节点。interface@link或@linkplain内联标记的树节点。interface@literal或@code内联标记的树节点。interface@param块标记的树节点。interface@provides块标记的树节点。interface用于引用 Java 语言元素的树节点。interface@return块标记的树节点。interface@see块标记的树节点。interface@serialData块标记的树节点。interface@serialField块标记的树节点。interface@serial块标记的树节点。interface@since块标记的树节点。interface@snippet内联标记的树节点。interface@spec块标记的树节点。interfaceHTML 元素开始的树节点。interface@summary内联标记的树节点。interface@systemProperty内联标记的树节点。interface纯文本的树节点。interface@exception或@throws块标记的树节点。interface无法识别的块标记的树节点。interface无法识别的内联标记的树节点。interface@uses块标记的树节点。interface@value内联标记的树节点。interface@version块标记的树节点。com.sun.source.doctree 中返回 DocTree 的方法返回类型中包含 DocTree 类型参数的 com.sun.source.doctree 中的方法修饰符和类型方法描述SnippetTree.getAttributes()返回@snippet标签的属性列表。StartElementTree.getAttributes()返回此元素定义的任何属性。DocCommentTree.getBlockTags()返回文档注释的块标签。DeprecatedTree.getBody()返回解释项目为何被弃用的描述。DocCommentTree.getBody()返回文档注释的正文,出现在第一句话之后和任何块标记之前。HiddenTree.getBody()返回解释项目隐藏原因的说明。SinceTree.getBody()返回说明正在记录的项目的可用性的文本。VersionTree.getBody()返回标签的主体。UnknownBlockTagTree.getContent()返回无法识别的块标记的内容。UnknownInlineTagTree.getContent()返回无法识别的内联标签的内容。IndexTree.getDescription()返回说明(如果有)。ParamTree.getDescription()返回参数的描述。ProvidesTree.getDescription()返回模块提供的服务类型的描述。ReturnTree.getDescription()返回方法返回值的描述。SerialDataTree.getDescription()返回串行数据的描述。SerialFieldTree.getDescription()返回序列字段的描述。SerialTree.getDescription()返回字段的描述,或单词“include”或“exclude”。ThrowsTree.getDescription()返回可能引发异常的原因的描述。UsesTree.getDescription()返回模块内服务类型使用的描述。DocCommentTree.getFirstSentence()返回文档注释的第一句。DocCommentTree.getFullBody()返回文档注释的整个主体,出现在任何块标记之前,包括第一句话。LinkTree.getLabel()返回链接的标签(如果有)。AuthorTree.getName()返回作者的姓名。DocCommentTree.getPostamble()返回包含文档注释内容之后的内容(如果有)的树列表。DocCommentTree.getPreamble()返回包含文档注释内容之前的内容(如果有)的树列表。SeeTree.getReference()返回引用。SummaryTree.getSummary()返回摘要或评论的第一行。SpecTree.getTitle()返回标题。AttributeTree.getValue()com.sun.source.doctree 中的方法,参数类型为 DocTree -
DocTree 在 com.sun.source.util 中的用法
com.sun.source.util 中返回 DocTree 的方法返回类型中包含 DocTree 类型参数的 com.sun.source.util 中的方法修饰符和类型方法描述DocTreeFactory.getFirstSentence(List<? extends DocTree> list) 获取内容列表中包含的第一句话。DocTrees.getFirstSentence(List<? extends DocTree> list) 返回表示评论第一句的DocTree列表。DocTreePath.iterator()com.sun.source.util 中的方法,参数类型为 DocTree修饰符和类型方法描述protected RSimpleDocTreeVisitor.defaultAction(DocTree node, P p) 默认操作,由所有未重写的访问方法使用。longDocSourcePositions.getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) 返回文件中注释中树的结束位置。static DocTreePathDocTreePath.getPath(DocTreePath path, DocTree target) 返回由DocTreePath对象标识的子树中树节点的文档树路径,如果未找到该节点,则返回null。static DocTreePathDocTreePath.getPath(TreePath treePath, DocCommentTree doc, DocTree target) 返回编译单元内树节点的文档树路径,如果未找到该节点,则返回null。longDocSourcePositions.getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) 返回文件中注释中树的起始位置。DocTreeFactory.newIndexTree(DocTree term, List<? extends DocTree> description) 创建一个新的IndexTree对象,代表一个{@index }标签。abstract voidDocTrees.printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root) 在提供的编译单元内的树位置打印指定类型的消息。扫描单个节点。扫描单个节点。final R调用特定于节点类型的适当访问方法。DocTreeScanner.visitOther(DocTree node, P p) 访问未知类型的DocTree节点。SimpleDocTreeVisitor.visitOther(DocTree node, P p) 访问未知类型的DocTree节点。com.sun.source.util 中的方法参数,类型参数为 DocTree修饰符和类型方法描述DocTreeFactory.getFirstSentence(List<? extends DocTree> list) 获取内容列表中包含的第一句话。DocTrees.getFirstSentence(List<? extends DocTree> list) 返回表示评论第一句的DocTree列表。DocTreeFactory.newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) 创建一个新的AttributeTree对象,以表示 HTML 元素或标记中的属性。DocTreeFactory.newAuthorTree(List<? extends DocTree> name) 创建一个新的AuthorTree对象,代表一个@author标签。DocTreeFactory.newDeprecatedTree(List<? extends DocTree> text) 创建一个新的DeprecatedTree对象,代表一个@deprecated标签。DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags) 创建一个新的DocCommentTree对象,代表一个完整的文档评论。DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) 创建一个新的DocCommentTree对象,代表整个文档评论。DocTreeFactory.newExceptionTree(ReferenceTree name, List<? extends DocTree> description) 创建一个新的ThrowsTree对象,代表一个@exception标签。DocTreeFactory.newHiddenTree(List<? extends DocTree> text) 创建一个新的HiddenTree对象,代表一个@hidden标签。DocTreeFactory.newIndexTree(DocTree term, List<? extends DocTree> description) 创建一个新的IndexTree对象,代表一个{@index }标签。DocTreeFactory.newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label) 创建一个新的LinkTree对象,代表一个{@linkplain }标签。DocTreeFactory.newLinkTree(ReferenceTree ref, List<? extends DocTree> label) 创建一个新的LinkTree对象,代表一个{@link }标签。DocTreeFactory.newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) 创建一个新的ParamTree对象,代表一个@param标签。DocTreeFactory.newProvidesTree(ReferenceTree name, List<? extends DocTree> description) 创建一个新的ProvidesTree对象,代表一个@provides标签。default ReturnTreeDocTreeFactory.newReturnTree(boolean isInline, List<? extends DocTree> description) 创建一个新的ReturnTree对象,以表示@return标签或{@return}标签。DocTreeFactory.newReturnTree(List<? extends DocTree> description) 创建一个新的ReturnTree对象,代表一个@return标签。DocTreeFactory.newSeeTree(List<? extends DocTree> reference) 创建一个新的SeeTree对象,代表一个@see标签。DocTreeFactory.newSerialDataTree(List<? extends DocTree> description) 创建一个新的SerialDataTree对象,代表一个@serialData标签。DocTreeFactory.newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) 创建一个新的SerialFieldTree对象,代表一个@serialField标签。DocTreeFactory.newSerialTree(List<? extends DocTree> description) 创建一个新的SerialTree对象,代表一个@serial标签。DocTreeFactory.newSinceTree(List<? extends DocTree> text) 创建一个新的SinceTree对象,代表一个@since标签。DocTreeFactory.newSnippetTree(List<? extends DocTree> attributes, TextTree text) 创建一个新的SnippetTree对象,代表一个{@snippet }标签。DocTreeFactory.newSpecTree(TextTree url, List<? extends DocTree> title) 创建一个新的SpecTree对象,代表一个@spec标签。DocTreeFactory.newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing) 创建一个新的StartElementTree对象,代表 HTML 元素的开始。default SummaryTreeDocTreeFactory.newSummaryTree(List<? extends DocTree> summary) 创建一个新的SummaryTree对象,代表一个{@summary }标签。DocTreeFactory.newThrowsTree(ReferenceTree name, List<? extends DocTree> description) 创建一个新的ThrowsTree对象,代表一个@throws标签。DocTreeFactory.newUnknownBlockTagTree(Name name, List<? extends DocTree> content) 创建一个新的UnknownBlockTagTree对象,以表示无法识别的块标记。DocTreeFactory.newUnknownInlineTagTree(Name name, List<? extends DocTree> content) 创建一个新的UnknownInlineTagTree对象,以表示无法识别的内联标签。DocTreeFactory.newUsesTree(ReferenceTree name, List<? extends DocTree> description) 创建一个新的UsesTree对象,代表一个@uses标签。DocTreeFactory.newVersionTree(List<? extends DocTree> text) 创建一个新的VersionTree对象,代表一个{@version }标签。扫描一系列节点。final R对一系列节点中的每一个调用适当的访问方法。com.sun.source.util 中的构造函数,参数类型为 DocTree -
DocTree 在 jdk.javadoc.doclet 中的用法
jdk.javadoc.doclet 中的方法参数,类型参数为 DocTree