코딩을 하다 보면 JIRA 같은 이슈 관리 시스템에 티켓으로 등록하기에는 작은 단위의 수정이나 개선 사항이 있습니다.


이런 경우 앞으로 할 일은 TODO, refactoring 이나 코드 정리가 필요한 사항은 FIXME 를 태그로 주석을 달아주면 향후에 업무 파악등에 유리합니다.

XXX 를 사용하는 경우도 있는데 개인적으로는 FIXME 와 구분이 어려워서 사용하지 않습니다.


인텔리 제이 계열 IDE 에서는 다음 절차로 이런 코드 단위 주석을 관리할 수 있습니다.


  1. Settings  → Editor  설정에 들어갑니다.
  2. TODO  에 들어가서 현재 패턴을 확인합니다.
  3. 새로운 코드 태그를 추가할 경우 우측의 ➕ 를 누른 후에 추가할 패턴을 정규식으로 기술합니다. 예로 버그를 기술하는 BUG 라는 코드 태그를 추가할 경우 아래와 같이 등록해 줍니다.

    \bBUG\b.*

    대소 문자를 구분하지 않을 경우 "case insensitive" 를 체크 해제합니다.


  4. Apply  를 눌러서 반영합니다.


태그 보기

view  → Tool Window → TODO 를 선택하면 현재 프로젝트의 전체 코드 태그 목록을 확인할 수 있습니다.

Ref





blog comments powered by Disqus