코드 주석에서 #XXX의 의미는 무엇입니까?

코드 주석에서 #XXX의 의미는 무엇입니까?

---

나는 이것을 코드에서 많이 보았으며, vim조차도 특별한 경우로 표시합니다. #TODO그리고 #FIXME다른 두 개의 고정 마커가 vim 하이라이트이지만 무엇을 #XXX의미합니까?

---

XXX의견에서 일반적으로 헤즈 업입니다. 그것은 수:

• 완전히 올바르게 구현되지 않은 것.
• 나중에 고쳐야 할 것.
• 가능한 문제 지점을 강조 표시합니다.
• 확실하지 않은 질문이 있습니다.

나는 종종 FIXMEor TODO또는 같은 더 설명적인 태그를 선호했습니다 HACK. XXX종종 위의 모든 것을 잡기 위해 사용됩니다.

FreeBSD 코드 상호 참조 에서 'XXX'를 검색 하는 것은 많은 용도의 좋은 예입니다. 수천이 있습니다 ...

---

• NOTE: 코드가 작동하는 방식에 대한 설명 (자체가 분명하지 않은 경우).
• XXX: 가능한 함정에 대한 경고는로 사용할 수 있습니다 NOTE:XXX:.
• HACK: 문제 / 버그를 피하기 위해 잘 작성되지 않았거나 형식이 잘못된 코드입니다. 로 사용되어야합니다 HACK:FIXME:.
• FIXME: 이것은 일종의 효과가 있지만 더 잘 할 수 있습니다. (보통 재 작성이 필요한 서두로 작성된 코드).
• BUG: 여기에 문제가 있습니다.
• TODO: 문제는 없지만 일반적으로 무언가를 건너 뛸 때 추가 코드를 작성해야합니다.

적어도 이것이 내가이 태그들에 대해 가르친 방법입니다. 기본적으로 처음 두 개 ( NOTE및 XXX)는 정보 용으로 사용되며 별도의 조치가 필요하지 않습니다. 마지막 세 개 ( FIXME, BUG및 TODO)에는 조치가 필요합니다. HACK사이에 어딘가에 있습니다 (그리고 거의 사용되지 않습니까?).

---

2005 년 6 월 Python Enhancement Proposal의 일부 노트 는 거부되었습니다 .

사이에 선택 FIXME하고하는 것은 XXX어려운 일이다.
XXX더 일반적이지만 설명이 훨씬 적습니다.
또한 알 수없는 값을 가진 XXX코드 조각에서 유용한 자리 표시 자입니다
.

따라서 FIXME선호하는 철자가 있습니다.
Sun은 말한다 XXX및 FIXME제공 약간 다릅니다 XXX높은 심각도를.
그러나이 주제에 대한 수십 년간의 혼란과
썬의 영향을받지 않는 너무 많은 개발자들이 동의어라고 부릅니다.

---

PEP는

이 PEP는 거부되었습니다. 커뮤니티가 관심을 가질 수 있지만
표준 라이브러리가이 표준을 준수하도록하려는 것은 없습니다.

...

코드 태그 란?

프로그래머는 애드혹 코드 주석 마크 업 규칙을 광범위하게 사용하여 면밀한 검사 또는 검토가 필요한 코드 섹션을 상기시킵니다. 마크 업의 예로는 FIXME, TODO, XXX, BUG, 기존 소프트웨어의 폭 넓은 사용이 많은하지만. 이러한 태그는 이제부터라고한다 codetags . 이러한 코드 태그는 응용 프로그램 코드, 단위 테스트, 스크립트, 일반 문서 또는 적절한 곳에 표시 될 수 있습니다.

---

PEP는 흥미로운 내용입니다.

---

PEP350 을 보십시오 . 그것은 모든 설명 TODO, XXX내가 코드 태그 수단의 정확히 무슨 일을 기억할 수없는 때 등 내가 그것을 매일 사용합니다.

---

XXX보다 입력하기가 쉽기 때문에 사용 합니다 TODO.

XXX 당신이 서둘러있을 때를위한 것이며 이것으로 다시 돌아올 것입니다.

TODO 다른 사람에게 전달해야 할 때입니다.

---

처리 방법을 모르는 경우 일 수 있습니다.
이것을 확인하십시오 : TODO / FIXME / XXX / HACK 문의 목록보기

대체 텍스트 http://editra-plugins.googlecode.com/svn/wiki/images/commentbrowser/cb_screenshot.PNG

---

(구) Java 코드 규칙에서 :

댓글에 XXX를 사용하여 허위이지만 작동하는 것을 신고합니다. FIXME를 사용하여 가짜 및 깨진 것을 표시하십시오.

---

XXX는 참고와 약간 다르지만 HACK과 매우 유사한 경고의 약자입니다. 사용중인 타사 라이브러리 / 코드의 버그 일 수 있으며 // XXX의 코드 : 타사 코드의 버그로 인한 해결 방법이거나 누군가보고 / 수정하는 사람에게 "주의"를 의미 할 수 있음을 나타냅니다 왜 어떤 식 으로든 무언가가 왜 처음에는 틀리거나 우아하지 않은 것처럼 보일 수 있는지를 나타내는 코드. HACK은 사용자 고유의 코드베이스 또는 타사 라이브러리에 존재할 수있는 문제에 대한 해결 방법을 의미하는 일반적인 용어입니다.

---

나는 FIXME개발자 HACK를위한 것이고 관리자 XXX를위한 것은 사용자를 위한 것이라고 생각 합니다.

예를 들어, XXX어떻게 작동하는지 이해하지 않고이 함수 를 무시하고 다른 곳에서이 함수를 호출하면 예상치 못한 일이 발생할 수 있으며이 문제를 다루는 사람은 불행 할 것입니다 (적어도 XXX생각 을 추가 한 사람 ). 이 기능을 사용하지 않으면 문제가 해결 될 것이라고 생각할 수 있습니다.

그러나을 위해 FIXME코드를 수정하여 작동하게 할 가치가 있다고 생각합니다. 그리고를 HACK사용하지 않아도 더 나은 선택이 없을 수 있습니다.

당신이 쓴 경우 XXX자신의 코드에 누군가가 그것을 사용, 당신은 완전히 그 코드를 다시 썼다처럼 당신은 이유로 불행 느낄 수 있으며, 그 다음 완전히 다른 방식으로 작동, 당신은 다른 사람의 코드를 끊었다. 그러나 당신이 FIXME또는 TODO대신에 떠나면 , 당신은별로 신경 쓰지 않을 것입니다.

참고URL : https://stackoverflow.com/questions/1452934/what-is-the-meaning-of-xxx-in-code-comments