Clean Code - 4장 주석

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

 

잘 달린 주석은 그 어떤 정보보다 유용하다.

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

 

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

 

우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

주석은 언제나 실패를 의미한다.

 

그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 상황을 역전해 코드로 의도를 표현할 방법은 없을까?

 

주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

 

주석은 오래될수록 코드에서 멀어진다.

오래될수록 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능 하기 때문에 완전히 그릇될 가능성도 커진다.

 

코드는 항상 변화하고 진화하기 때문에 주석은 무의미하다.

 

주석을 가능한 줄이도록 꾸준히 노력해야 한다.

 

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

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

모듈을 짜고 보니 짜임새가 엉망이고 알아먹기 어렵다. 지저분한 모듈이라는 사실을 자각한다.

그래서 자신에게 이렇게 말한다. "이런! 주석을 달아야겠다!" 아니다! 코드를 정리해야 한다!

 

표현력이 풍부하고 깔금하며 주석이 거의 없는 코드가, 복작하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!

 

2. 코드로 의도를 표현하라!

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

다음 코드는 어떤가?

if (employee.isEligibleForFullBenefits())

주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

 

3. 좋은 주석

어떤 주석은 필요하거나 유익하다.

하지만 명심하기 바란다. 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!

 

법적인 주석(70.p 참고), 정보를 제공하는 주석(71.p 참고), 의도를 설명하는 주석(71.p 참고), 의미를 명료하게 밝히는 주석(72.p 참고), 결과를 경고하는 주석(73.p 참고), TODO 주석 (74.p 참고), 중요성을 강조하는 주석(75.p 참고)

 

4. 나쁜 주석

대다수 주석이 이 범주에 속한다.

 

4.1. 주절거리는 주석(76.p)

 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다.

 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

 저자에게만 의미있는 주석이고 그 의미가 다른 사람들에게 전해지지 않는 주석

4.2. 같은 이야기를 중복하는 주석(77.p)

 코드만 봐서 알 수 있는 내용을 굳이 주석으로 달아 놓은 경우

4.3. 오해할 여지가 있는 주석(79.p)

4.4. 의무적으로 다는 주석(80.p)

 모든 함수에 주석을 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.

 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.

4.5. 이력을 기록하는 주석

 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례로 혼란만 가중된다.

4.6. 있으나 마나 한 주석

 너무나 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.

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

4.7. 닫는 괄호에 다는 주석

 중첩이 심하고 장환한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다.

 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려고 시도하자.

4.8. 공로를 돌리거나 저자를 표시하는 주석

4.9. 주석으로 처리한 코드

4.10. 너무 많은 정보