나는 이것을 코드에서 많이 보았고 심지어 vim도 특별한 경우로 표시합니다. #TODO
그리고 #FIXME
다른 두 개의 수정 마커가 vim 하이라이트이지만 무엇을 #XXX
의미합니까?
답변
XXX
댓글에는 일반적으로 헤드 업이 있습니다. 그것은 수:
- 완전히 올바르게 구현되지 않은 것.
- 나중에 수정해야 할 사항입니다.
- 가능한 문제 지점을 강조합니다.
- 확실하지 않은 질문입니다.
나는 종종 FIXME
또는 TODO
또는 같은 더 설명적인 태그를 선호했습니다 HACK
. XXX
위의 모든 것을 잡기 위해 자주 사용됩니다.
FreeBSD 코드 상호 참조 에서 ‘XXX’를 검색 하는 것은 여러 용도의 좋은 예입니다. 수천이 …
답변
NOTE
: 코드 작동 방식에 대한 설명 (자명하지 않은 경우).XXX
: 가능한 함정에 대한 경고로NOTE:XXX:
.HACK
: 문제 / 버그를 피하기 위해 잘 작성되지 않았거나 잘못된 코드입니다. 로 사용해야합니다HACK:FIXME:
.FIXME
: 이것은 일종의 효과가 있지만 더 잘 할 수 있습니다. (보통 재 작성이 필요한 서둘러 작성된 코드).BUG
: 여기에 문제가 있습니다.TODO
: 문제 없습니다. 일반적으로 무언가를 건너 뛸 때 추가 코드를 작성해야합니다.
적어도 이것이 내가 이러한 태그에 대해 배운 방법입니다. 기본적으로 처음 두 개 ( NOTE
및 XXX
)는 정보에 사용되며 조치가 필요하지 않습니다. 마지막 세 개 ( FIXME
, BUG
및 TODO
)는 조치가 필요합니다. HACK
사이 어딘가에 있습니다 (내 생각에는 거의 사용하지 않습니까?).
답변
거부 된 2005 년 6 월 Python 향상 제안의 일부 메모 .
FIXME
와 사이를 선택하는XXX
것은 어렵습니다.
XXX
더 일반적으로 보이지만 훨씬 덜 설명 적입니다.
또한
알 수없는 값을 가진XXX
코드 조각에서 유용한 자리 표시 자입니다
.따라서
FIXME
선호되는 철자입니다.
Sun은 말한다XXX
및FIXME
제공 약간 다릅니다XXX
높은 심각도를.
그러나이 주제에 대한 수십 년의 혼란과
Sun의 영향을받지 않는 수백만 명의 개발자로 인해 동의어라고 올바르게 부르기가 쉽습니다.
PEP는 다음으로 시작합니다.
이 PEP는 거부되었습니다. 커뮤니티가 관심을 가질 수 있지만
표준 라이브러리가이 표준을 따르도록 만들려는 욕구는 없습니다.
…
코드 태그 란?
프로그래머는 면밀한 검사 또는 검토가 필요한 코드 섹션을 상기시키는 역할을하기 위해 임시 코드 주석 마크 업 규칙을 널리 사용합니다. 마크 업의 예로는
FIXME
,TODO
,XXX
,
BUG
, 기존 소프트웨어의 폭 넓은 사용이 많은하지만. 이러한 태그는 이제부터라고한다 codetags . 이러한 코드 태그는 응용 프로그램 코드, 단위 테스트, 스크립트, 일반 문서 또는 적절한 위치에 표시 될 수 있습니다.
PEP는 흥미로운 읽기입니다.
답변
답변
. XXX
보다 입력하기 쉽기 때문에 사용 합니다 TODO
.
XXX
당신이 서둘러서이 문제로 돌아올 때를위한 것입니다.
TODO
다른 사람에게 넘겨야 할 때입니다.
답변
아마도 처리 방법을 모르는 경우 일 것입니다.
이것을 확인하십시오 : TODO / FIXME / XXX / HACK 문의 목록보기
대체 텍스트 http://editra-plugins.googlecode.com/svn/wiki/images/commentbrowser/cb_screenshot.PNG