[클린코드] 4장. 주석

"나쁜 코드에 주석을 달지 마라. 새로 짜라"

 

잘 달린 주석은 유용하다.

하지만, 경솔하고 근거 없는 주석을 코드를 이해하기 어렵게 만든다.

오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.

 

그러니, "나쁜 코드에 주석을 달지 마라. 새로 짜라"

 

 

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

 - 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65)) 

 

if (employee.isEligibleForFullBenefits())

 - 위의 코드에서 보이듯, 표현력이 풍부하고 깔끔한 코드가 주석이 주렁주렁 달린 코드 보다 훨씬 낫다.

 

함수나 변수로 표현할 수 있다면 주석을 달지 마라.

 

너무 많은 정보를 장황하게 늘어 놓는 주석은 달지 마라.