SnippetTree

SnippetTree (@snippet 인라인 태그 노드)

문서 주석 안의 @snippet 인라인 태그를 표현하는 트리 노드입니다. 문서에 코드 조각을 포함시키기 위해 쓰이는 태그예요.

출처: Java API Reference

본문

다음과 같은 여러 형태의 @snippet 태그를 나타냅니다.

{@snippet :
     body
    }
{@snippet attributes}
{@snippet attributes :
     body
    }

속성(attributes)만 있는 형태, 본문(body)만 있는 형태, 또는 둘 다 있는 형태로 사용됩니다. Java 18부터 존재해요.

public interface SnippetTree extends InlineTagTree

getAttributes()

public List<? extends DocTree> getAttributes()

@snippet 태그의 속성 목록을 반환합니다.

getBody()

public TextTree getBody()

@snippet 태그의 본문을 반환하며, 본문이 없으면 null을 돌려줍니다. 주의할 점이 하나 있어요. 본문이 없는 인스턴스와 본문이 빈 인스턴스는 서로 다릅니다. 본문이 없으면 이 메서드는 null을, 본문이 비어 있으면 getBody()가 빈 문자열을 돌려주는 TextTree를 반환해요.

더 알아보기 (Learn more)

Java 공식 API