사람들은 머리속에 들어있는 맥락에 얼마나 의존하고 있는지 깨닫지 못하고 자신의 코드가 아무 설명없이도 명백하다고 생각하고 있다.
자신의 코드를 새롭게 접하는 사람이나 심지어 미래의 자신 조차도 작성 당시 머리속의 맥락을 알지 못한다.
간결하고 중요한 내용만 코멘트로 작성하기만 해도 많은 사람들의 많은 시간을 절약할 수 있지만 시간은 몇 초밖에 걸리지 않는다.
그만큼 주석 작성과 문서화의 위력은 크다.
물론 우리들은 모든 코드는 그 자체만으로도 문서의 역할을 해야하며 모든 주석이 도움이 되지 않는다는 것을 안다.
하지만 그럼에도 불구하고 우리들은 필요한 최소한의 코멘트를 작성하는 것 조차 하지 않는 경향이 있다.
우스갯소리로 코멘트 작성은 운동과 같다는 말이 있다.
기술적인 측면에서 과도하게 시행하는 경우도 있긴 하지만, 대부분은 너무 적게한다.
따라서 우리는 작성의 수준을 올려야 한다.
// Not if anything comes before it.
if (_chunks.isNotEmpty) return false;
영어로 작성하는 경우 문장처럼 첫 글자를 대문자로 작성하고 마지막엔 마침표, 느낌표, 물음표 등으로 작성해야 한다.
이것은 모든 주석, 문서화, 인라인, TODO도 마찬가지이며 문장의 일부만 작성하는 경우에도 동일하다.