Интерфейс DocCommentTree

Все суперинтерфейсы:: DocTree

public interface DocCommentTree extends DocTree

Представление комментария документации верхнего уровня.

   first-sentence body block-tags

Начиная с:: 1.8

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в интерфейсе DocTree

DocTree.Kind

Модификатор и тип	Интерфейс	Описание
`static enum`	`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()`	Возвращает список деревьев, содержащих содержимое (если оно есть), предшествующее содержимому комментария документации.

Методы, объявленные в интерфейсе DocTree

accept, getKind

Модификатор и тип	Метод	Описание
`<R,D> R`	`accept(DocTreeVisitor<R,D> visitor, D data)`	Метод accept, используемый для реализации шаблона посетителя.
`DocTree.Kind`	`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, 2025, 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.