의도 확인
구현 선택의 이유, 대안 대비 판단, 안전성 전제가 드러나는지 봅니다.
좋은 주석은 코드 변경과 함께 점검됩니다
주석은 “무엇을 하는가”보다 “왜 그렇게 했는가”와 “무엇을 조심해야 하는가”를 남길 때 오래 살아남습니다.
코드와 대조
현재 동작과 주석 설명이 어긋나면 주석을 고치거나 제거합니다.
유지 비용 판단
반복 설명은 줄이고, 다음 수정자가 놓치기 쉬운 제약만 남깁니다.
남길 주석
경계값, 실패 조건, 성능 타협, 안전성 가정
줄일 주석
코드 한 줄을 그대로 풀어쓴 설명, 오래된 동작 설명