DocCommentTree

DocCommentTree (문서 주석 최상위 노드)

문서 주석(doc comment)의 최상위 표현을 담당하는 트리 노드입니다. 하나의 문서 주석 전체를 나타내는 루트 노드예요.

출처: Java API Reference

문서 주석은 다음과 같은 구조로 이뤄집니다.

first-sentence body block-tags

첫 문장 → 본문 → 블록 태그 순서로 구성되며, DocCommentTree는 이 전체를 한 번에 담아요. Java 1.8부터 존재합니다.

public interface DocCommentTree extends DocTree

public List<? extends DocTree> getFirstSentence()

문서 주석의 첫 문장을 반환합니다. 요약으로 쓰이는 부분이에요.

public List<? extends DocTree> getBody()

첫 문장 뒤, 블록 태그 앞에 오는 본문을 반환합니다.

default List<? extends DocTree> getFullBody()

블록 태그 앞에 오는 전체 본문을 반환합니다. 첫 문장도 포함돼요. Java 9부터 추가되었습니다.

public List<? extends DocTree> getBlockTags()

문서 주석의 블록 태그들을 반환합니다.

default List<? extends DocTree> getPreamble()
default List<? extends DocTree> getPostamble()

내용 앞(전문)과 뒤(후문)에 오는 트리 목록을 반환합니다. Java 소스 파일의 문서 주석에서 읽으면 보통 빈 목록이지만, HTML 파일에서 읽으면 <body> 태그 전후의 내용이 담겨요. 기본 구현은 빈 목록을 반환합니다. Java 10부터 추가되었어요.