ParamTree

ParamTree (@param 문서 태그 노드)

문서 주석 안의 @param 블록 태그를 표현하는 트리 노드입니다. 메서드나 생성자의 매개변수 설명을 담아요.

출처: Java API Reference

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

@param parameter-name description

@param 뒤에 매개변수 이름과 그 설명이 이어지는데, 이 노드는 그중 이름과 설명, 그리고 타입 매개변수 여부를 따로 알려줍니다. Java 1.8부터 존재해요.

public interface ParamTree extends BlockTagTree

public IdentifierTree getName()

매개변수의 이름을 반환합니다. 반환 타입이 IdentifierTree인 것이 특징이에요.

public List<? extends DocTree> getDescription()

매개변수에 대한 설명을 반환합니다.

public boolean isTypeParameter()

이 태그가 타입 매개변수(type parameter)를 문서화하는 것인지 여부를 반환합니다. 제네릭 타입 매개변수 <T>를 설명하는 @param이라면 true를 돌려줘요.