Comment the Why
코드가 ‘무엇을’이 아니라 ‘왜 이렇게 예외를 뒀는지’를 짧게 남기는 주석
쉽게 말하면, 레시피에 ‘소금 2큰술’이 아니라 ‘간장이 짜서 소금은 줄임’을 적는 것입니다.
모바일에서만 숨기는 CSS, 보안상 막은 경로처럼 이상해 보이는 줄 위에 이유를 달 때입니다.
코드를 그대로 옮긴 주석은 곧 거짓말이 됩니다. 이유가 사라지면 주석도 지우세요.
관련 용어