의도 설명
코드가 어떻게 동작하는지는 코드로, 왜 필요한지는 주석으로 보완한다.
Comments
주석은 코드가 말하지 못하는 의도와 제약을 보완한다
좋은 주석은 코드 설명을 반복하지 않고, 왜 그렇게 했는지와 바꾸면 안 되는 조건을 알려 준다.
주석 판단 기준
code context주의 조건
성능, 안전성, 외부 API 제약처럼 놓치면 위험한 맥락을 남긴다.
문서 주석
공개 함수와 타입에는 사용자가 알아야 할 계약을 설명한다.
관리
코드와 어긋난 주석은 없느니만 못하므로 변경 시 함께 갱신한다.
codewhyconstraintdoc
주석은 부족한 코드의 변명이 아니라, 읽는 사람이 같은 판단을 반복하지 않도록 맥락을 남기는 장치다.