EscapeTree

EscapeTree (이스케이프 시퀀스 노드)

이스케이프 시퀀스(escape sequence)로 표현되는 문자 하나를 나타내는 트리 노드입니다. 문서 주석 안에서 특수 문자가 태그로 오인되지 않도록 쓴 이스케이프를 담아요.

출처: Java API Reference

본문

public interface EscapeTree extends TextTree

이 클래스는 자체적으로 유효한 이스케이프 시퀀스의 집합을 제한하지 않지만, 실제로는 표준 Doclet용 문서 주석 명세에 정의된 것들로 효과적으로 제한됩니다. 대표적으로 상황에 따라 달라지는 이스케이프 시퀀스가 몇 가지 있어요.

  • @@ — 그대로 두면 블록 또는 인라인 태그의 시작으로 해석될 @를 나타냅니다.
  • @/*@/의 일부로 쓰여 */를 나타내는 /를 표현합니다.
  • @* — 줄 시작의 공백 뒤에서, 그대로 두면 버려질 *를 나타냅니다.

Java 21부터 존재합니다.

public interface EscapeTree extends TextTree

getBody()

public String getBody()

오염된 텍스트를 반환합니다. 주의할 점은, 이 메서드는 원래의 이스케이프 시퀀스가 아니라 **탈출된 문자(escaped character)**를 돌려준다는 거예요. 즉 @@@로, @//로 반환되는 식입니다.

더 알아보기 (Learn more)

Java 공식 API