2013. 12. 3.

주석은 무엇을 하는지 설명해야 하는게 아니라 왜 그렇게 했는지를 설명해야 한다.

최근 읽기 시작한 Effective Unit Testing  이라는 책을 보다 매우 마음에 와 닿는 말이 있어서 적어본다.

Note - 좋은 주석의 조건
결론부터 말하면 '무엇을'이 아닌 '왜'를 설명하는 주석이 좋은 주석이다.

코드가 무엇을 하는지 설명하는 주석은 무조건 코드 냄새라고 보면 된다. 그런 주석이 필요없을 만큼 쉽게 읽을 수 있는 코드를 작성해야 한다. 주석이 정말 필요한 경우는 많지 않은데, 특정 코드 불록의 정당성을 설명하는 주석 정도가 그에 해당한다.
예를 들어 복잡한 for 문이 무슨 일을 하는지 설명하는 주석은 냄새일 가능성이 높다. 그에 반해 유사한 for 문이더라도 성능 최적화가 꼭 필요한 부분이라 어쩔 수 없이 가독성을 다소 희생한 경우라면 의미 있는 올바른 주석이 될 수 있다.
주석을 작성할 때마다 자신에게 물어보자. '무엇'을 설명하려는가 아니면 '왜'를 설명하려 하는가? 그리고 주석 작성과 리팩토링 중 무엇이 진정 필요한 것인지 다시 한 번 생각해보자.

Effective Unit Testing : 클린 코드와 좋은 설계를 이끄는 단위 테스트 중에서...

원서정보 : ISBN 9781935182573
번역서정보 : ISBN 9788968480621