ThrowsTree

ThrowsTree (@exception / @throws 문서 태그 노드)

문서 주석 안의 @exception 또는 @throws 블록 태그를 표현하는 트리 노드입니다. 메서드가 던질 수 있는 예외를 문서화하는 데 쓰여요. @exception@throws의 동의어입니다.

출처: Java API Reference

본문

다음과 같은 두 가지 형태의 태그를 나타냅니다.

@exception class-name description
@throws class-name description

Java 1.8부터 존재합니다.

public interface ThrowsTree extends BlockTagTree

getExceptionName()

public ReferenceTree getExceptionName()

문서화되는 예외의 이름을 반환합니다. 어떤 예외 클래스를 설명하고 있는지가 이 값으로 드러나요.

getDescription()

public List<? extends DocTree> getDescription()

해당 예외가 왜 던져질 수 있는지에 대한 설명을 반환합니다.

더 알아보기 (Learn more)

Java 공식 API