콘텐츠로 이동

TODO 주석 (TODO Comments)

임시적이거나 단기적인 솔루션이거나 충분하지만 완벽하지는 않은 코드에는 TODO 주석을 사용하세요.


이해하기 쉽게 설명하기

핵심: 임시·미완성 코드에 TODO

임시방편이거나, 단기 해결책이거나, "충분하지만 완벽하지는 않은" 코드에는 TODO 주석을 남기세요.

형식

TODO 다음에 더 알아볼 사람이 참고할 맥락(이슈 번호, 이름 등)을 괄호로 적고, 무엇을 해야 하는지 설명합니다.

// TODO(bug 12345): 캐시 무효화를 정확한 방식으로 다시 구현한다.
// TODO(kim): null 입력 처리를 추가한다.

TODO에 적은 이름이 그 작업을 반드시 하겠다는 약속은 아닙니다 — 더 알아볼 때 연락할 사람을 가리킬 뿐입니다.