Github 에 있는 남의 코드를 읽다보면 FIXME, TODO 같은 것을 간혹 발견할 수 있다. 평소에 이런 주석을 많이 보기는 했지만 적극적으로 이용하지는 않았는데, 앞으로 이를 적급적으로 활용하는게 좋을 것 같아서 이런 코드를 찾아 봤다.
따로 정리된 규칙이 있는지 찾아 봤는데, 딱히 없는 것 같다. 그래도 가장 정리는 된 문서는 https://peps.python.org/pep-0350/ 이거 같다.
* FIXME : 깔끔하지 않는 코드라서 정리가 필요한 코드
* TODO : 처리해야 하는 작업, 보통 함수 이름만 만들어 두고 내부는 TODO로 하는 식으로 처리하는 것 같다.
* HACK : 버그를 수정하기 위한 유연하지 못한 방법, (알려진 버그 하나만을 처리하기 위한 좀 무식한 코드나 꼼수에 사용하는 것 같다. )
여기 까지가 사람들이 가장 많이 사용하는 codetag 인 것 같고, 다음 codetag 들은 잘 사용하면 유용할 것 같다.
* SEE : 참고해야할 다른 코드나 문서 URL 을 표시할 때
* NOTE : 코드를 리뷰하는 사람이 다는 코멘트
* !!! : 주의, 경고 사항
* ??? : 알 수 없음. 물음. (가끔 내가 작성한 코드이긴 하나 왜 이런 코드가 들어가 있지 하고 생각할 때 추가할만하다.)
* BUG : 버그,(알고 있는 버그인데 특수한 사항에만 적용되는 경우라서 알고 있는데, 딱히 수정하지 않을 때 사용할만 하다. )
* PORT : 호환성 문제(개발환경에서만 문제가 된다든지, 배포 환경에서만 동작한다든지에 관한 사항)