[클린코드] 4장 - 주석

나쁜 코드에 주석을 달지 마라. 새로 짜라.
- 브라이언 W. 커니핸, P.J. 플라우거 -

 

주석은 순서하게 악하다. 우리가 프로그래밍 언어를 치밀하게 사용하여 코드의 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라. 주석은 반겨 맞을 손님이 아니다. 주석이 없고 깔끔한 코드가 복잡하고 어수선하고 주석이 많이 달린 코드보다 훨씬 좋다.

 

주석은 오래될수록 코드에서 멀어진다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능 하니까. 필자는 그래서 코드를 설명하는 문서를 작성하는 것을 지양하는 편이다. 유지보수 관리해야하는 포인트가 2개로 늘어나기 때문이다. 이 책에서도 주석을 달아야 한다면, 코드를 더 깔끔하게 정리하거나 보수해야한다고 말한다. 우리는 우리가 쓰는 코드에 우리의 의도를 모두 표현해야 한다.

 

따라서 저자의 의도를 명확하게 표현하기 위한 주석은 괜찮다. 비슷한 이유로 생각하지 못한 결과를 마리 경고하는 주석, TODO 주석, 중요성을 강조하는 주석 모두 코드만 보고 독자가 의도를 알아내기 어려울 것 같다면 사용할 수 있는 방법이다.

 

우리가 코드에 우리의 의도와 이야기를 적어두었는데 이를 주석으로 반복하고 있다면, 주석을 읽는데 시간이 더 오래 걸릴 수 있다. 또한 그렇게 작성된 주석이 우리의 의도와 이야기에서 아주 약간이라도 틀리다면 오해를 불러이르킨다. 이런 주석은 없으니만 못하다.

 

닫는 괄호에 닫는 주석이 인상적이다. 함수나 괄호 사이 블럭의 사이즈가 크면 유용할 수 있으나, 애초에 코드는 그렇게 길면 안된다. 닫는 괄호에 주석을 달고 싶다면, 함수나 블럭 사이즈를 줄이려고 해보자.

 

이 책의 필자가 애초에 주석을 다는 것을 크게 좋아하지 않는 것 같아. 4장의 내용은 길지 않았다. 주석에 대해서 새롭게 생각해볼 수 있는 시간이었다.