주석 태그 (Task Tag)
주석 태그 (Task Tags)
- 코드에 주석을 추가할 때 사용하는 키워드.
- TODO(할일), FIXME(수정 필요), NOTE(메모) 등.
- IDE 나 코드 에디터에서 주석 안에 해당 키워드들을 사용하면 색깔이 변함.
- 이는 주석의 성격을 분류하거나,
- 혹은 나중에 처리하도록 쉽게 식별할 수 있도록 표시하는 목적으로 사용됩니다.
주석 태그의 명칭?
- 여러 명칭으로 불러짐. 딱히 정해진 명칭은 없는 듯.
- Task Tags : 할일 태그. 가장 흔하게 사용됨.
- Comment Tag : 주석 태그.
- Comment Keywords : 주석 키워드.
- Annotation Comment : 주석 기반 주석.
- Comment Marker : 주석 마킹.
Task Tag 의 종류
| 태그 | 설명 |
|---|---|
| TODO | 추후 구현이 필요한 작업을 나타냅니다. |
| FIXME | 수정이 필요한 버그나 문제를 표시합니다. |
| NOTE | 중요한 설명이나 참고사항을 남길 때 사용합니다. |
| REVIEW | 코드 리뷰나 재검토가 필요한 부분을 나타냅니다. |
| HACK | 임시방편으로 작성된 비효율적인 코드를 표시합니다. |
| BUG | 알려진 버그를 명시합니다. |
| OPTIMIZE | 성능 향상이 필요한 부분을 나타냅니다. |
| DEPRECATED | 더 이상 사용되지 않거나 사용 예정이 없는 코드를 표시합니다. |
협업에서의 장점
- 협업시 어떤 부분을 수정해야 하는지, 개선이 필요한지 빠르게 파악 가능
- 주석 대상 코드 블럭에서 해야할 일을 명시할 수 있음.
- 따라서 협업, 유지보수 과정에서 유용하게 활용됨.
Reference
https://en.wikipedia.org/wiki/Comment_(computer_programming)
Comments