[Clean Code] 4. 주석

주석은 나쁜 코드를 보완하지 못한다

주석에 코드를 추가하는 이유는 코드 품질이 나쁘기 때문이다.

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 주석이 달린 코드보다 낫다.

코드로 의도를 표현하라!

코드만으로 의도를 표현하기 힘든 코드가 있을 수 있다.

if ((employee.flags & HOURLY_FLAG) && (employee.ege > 65))

이러한 코드에 의미를 설명하는 주석을 추가하기 보다는 함수로 의미를 표현해라.

if (employee.isEligibleForFullBenefits())

좋은 주석

• 법적인 주석
• 정보를 제공하는 주석
• 의도를 설명하는 주석
• 의미를 명료하게 밝히는 주석
• 결과를 경고하는 주석
• TODO 주석
• 중요성을 강조하는 주석

나쁜 주석

• 주절거리는 주석
• 같은 이야기를 중복하는 주석
• 의무적으로 다는 주석
• 있으나 마나 한 주석
• 닫는 괄호에 다는 주석
• 공로를 돌리거나 저자를 표시하는 주석
• 주석으로 처리한 코드
• 전역 정보
• 너무 많은 정보
• 모호한 관계
• 함수 헤더