주석 태그(Comment Tag)

소스 코드나 문서에서 사용되는 특정 표시.
이 표시를 통해 개발자에게 추후 작업 처리나 수정해야할 코드를 알린다.
이러한 주석 태그를 통해 작업 추적 및 협업을 원활하게 진행할 수 있다.

주석 태그의 종류

• IntelliJ 내에서 최초 제공하는 주석 태그는 TODO, FIXME가 있고 그 밖의 커스텀 주석 태그를 만들 수 있다.
• HACK, XXX, BUG, DEBUG 와 같은 경우는 커스텀 태그로 자주 사용된다.

TODO

아직 해결되지 않은 작업이나 구현해야할 부분을 나타내는 주석 태그

주석으로 TODO와 함께 어떤 작업이 필요한지 간단히 설명하고 나중에 찾기 쉽도록 남겨둔다.

// TODO: 추후에 하드코딩을 개선해야 한다.

FIXME

수정이 필요한 버그, 오류, 또는 잘못된 동작을 나타내는 주석 태그

FIXME 주석 태그를 포함하고 어떤 문제가 있는지 설명하고 이를 해결해야하는 이유를 기록한다.
코드나 문서를 검토할 때 빠른 수정이 필요한 부분을 강조하는데 사용된다.

// FIXME: 해당 코드에서는 런타임 오류가 발생합니다. 수정해야 합니다.

IntelliJ에서 태그 위치 확인 방법

View 탭 > Tool Windows 탭 > TODO

참고

[IntelliJ] 주석 태그 & 키워드 활용하기 : TODO, FIXME, Custom Comment Tag