Интерфейс 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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.compiler/com/sun/source/doctree/DocCommentTree.html