코드 중간중간에 붙이는 주석 codetag(코드태그)의 목록

• 파이썬 코드 내부에 XXX나 기타 희한한 문구를 붙여놓길래 뭔가해서 찾아보았다.
  코드에 주석달 때 쓸만하겠다.
• 내가 한글로 가볍게 번역해놨다.
  내가 직접 번역 못한 것은 24.06에 챗지피티를 활용해서 이해 안되는 내용을 번역했다.
• 코드 태그는 해당 목적을 나타내는 줄임말이므로, 다양한 명칭이 가능하다.
  • 실제로는 하나의 코드 태그만을 쓰는게 나중에 찾기 좋다.
  • 글자수를 줄이는 것은 좋지만, 모음을 줄여 헷갈리게 만드는 것보단 차라리 긴 게 나을 것이다.
    MILESTONE  >= MLSTN

 

https://peps.python.org/pep-0350/

PEP 350 – Codetags | peps.python.org

코드 예시

 

# FIXME: for문을 써야 할 것이다. <>
while True:
	print('1')

 

 

코드태그 종류
1번: 할일
종류: TODO, MILESTONE / MLSTN, DONE, YAGNI, TBD, TOBEDONE 
설명: 완성하는데 필요한 비공식 내용을 쓸 때.

2번: 고치기
종류: FIXME, XXX, DEBUG, BROKEN, REFACTOR / RFCTR / REFACT,OOPS, SMELL, NEEDSWORK, INSPECT
설명: 문제가 있거나 깔끔하지 못한 코드를, 수정하여 다듬어야 할 때.

3번: 버그확인
종류: BUG / BUGFIX
설명: 확인된 버그가 나타나는 부분에.

4번: 버그수정불가 
종류: NOBUG, NOFIX, WONTFIX, DONTFIX, NEVERFIX, UNFIXABLE, CANTFIX
설명: 문제가 있으나 현실의 제약 때문에 고칠 수 없을 때.

5-1번: 요구사항
종류: REQ/REQUIREMENT, STORY
설명: 요구사항 충족에 필요한 사항들이 있을 때.

5-2번: 개선요청
종류: FE, FEETCH, NYI, FR, FTRQ, FTR
설명: 해당 항목이 구현되지 않았을 때
설명: IDEA 는 RFE 보다 좀 더 비공식적인 요청일 때 적는다.

6번: 의문점
종류: ???, QUESTION, QUEST, QSTN, WTF
설명: 제대로 이해하지 못했을 때.

7번: 경고
종류: !!!, ALERT
설명: 즉각 주의해야 할 때.

8번: 꼼수(?)
종류: HACK, CLEVER, MAGIC
설명: 유연하지 않은 기능을 강제로 작동시키기 위한 임시 코드이거나, 단순한 테스트 변경이거나, 알려진 문제를 해결하기 위한 우회책

9번: 호환성
종류: PORT, PORTABILITY, WKRD
설명: 특정한 운영체제(OS)나 프로그래밍 언어의 특정 버전 등에 특화된 내용

10번: 주의
종류: CAVEAT, CAV, CAVT, WARNING, CAUTION
설명: 비직관적으로 돋보이는 구현 세부사항/주의사항

11번: 참고사항
종류: NOTE, HELP
설명: 코드 리뷰어가 논의나 추가 조사가 필요한 사항을 발견한 섹션

12번: 자주묻는질문
종류: FAQ
설명: 다수에게 추가 설명이 필요할 때.

13번: 용어 정의
종류: GLOSS, GLOSSARY
설명: 프로젝트 용어집에 대한 정의

14번: 참조
종류: SEE, REF, REFERENCE
설명: 외부 참고자료를 인용하거나 안내할 때.

15번: 문서요청
종류: TODOC, DOCDO, DODOC, NEEDSDOC, EXPLAIN, DOCUMENT
설명: 코드 안내서가 필요할 때.

16번: 인용
종류: CRED, CREDIT, THANKS
설명: 제3자의 저작물을 인용하는 것에 대한 (감사와 그것을 사용한다는) 표현

17번: 상태
종류: STAT, STATUS
설명: 파일 성숙도를 나타내는, 파일 수준의 통계적 지표

18번: 검증확인
종류: RVD, REVIEWED, REVIEW
설명: 분석관이 코드를 확인했을 때.