Taglet

Taglet (사용자 정의 태그 처리 태그렛)

표준 독렛 같은 독렛들이 지원하는 사용자 정의 태그렛을 위한 인터페이스입니다. 문서 주석의 사용자 정의 태그를 처리하는 데 사용됩니다.

출처: Java API Reference

본문

Taglet은 문서 주석에 나타나는 사용자 정의 태그를 처리하는 컴포넌트입니다. 맞춤 태그는 개별적으로 블록 태그(block tag) 또는 인라인 태그(inline tag)로 인스턴스화될 수 있습니다. 블록 태그는 주석 끝에 나타나고, 인라인 태그는 문서 주석의 본문 안 어디에나 나타날 수 있습니다.

각 태그렛 구현은 독렛이 태그렛을 인스턴스화하는 데 사용하는 공개 무인자 생성자를 제공해야 합니다.

독렛은 이 인터페이스를 구현하는 클래스와 다음과 같이 상호작용합니다. 태그렛 클래스의 무인자 생성자로 인스턴스를 만들고, 다음으로 적절한 환경과 독렛을 사용해 init 메서드를 호출합니다. 이후 태그 이름을 얻는 getName, 태그를 허용하는 위치를 얻는 getAllowedLocations, 그리고 isInlineTag 등을 호출합니다.

이를 통해 javadoc 문서에 프로젝트 고유의 태그(@since, @author 외 맞춤 태그 등)를 추가해 문서 표현을 확장할 수 있습니다.

더 알아보기 (Learn more)

Java 공식 API