(클린코드) 4장. 주석

4장. 주석

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

주석은 순수하게 선하지 못하다. 사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면 주석은 거의 필요하지 않으리라.

코드로 의도를 표현하지 못해 (실패를 만회하기 위해) 주석을 사용한다.

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

주석을 유지보수하기란 현실적으로 불가능해서 오래될수록 완전히 그릇될 가능성도 커진다.

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 부정확한 주석은 결코 이뤄지지 않을 기대를 심어준다. 진실은 한 곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일의 정보를 정확히 제공하는 유일한 출처다.

그러므로 주석을 가능한 줄이도록 노력해야한다.

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

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

코드로 의도를 표현하라.

좋은 주석

아래와 같은 경우 주석은 필요하거나 유익하다.

하지만 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이다.

법적인 주석

정보를 제공하는 주석

의도를 설명하는 주석

의미를 명료하게 밝히는 주석

결과를 경호하는 주석

TODO 주석

중요성을 강조하는 주석

공개 API에서 Javadocs

 

나쁜주석

주절거리는 주석

같은 이야기를 중복하는 주석

오해할 여지가 있는 주석

의무적으로 다는 주석

이력을 기록하는 주석

있으나 마나한 주석

무서운 잡음

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

위치를 표시하는 주석

닫는 괄호에 다는 주석

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

주석으로 처리한 코드

HTML 주석

전역 정보

너무 많은 정보

모호한 관계

함수 헤더

비공개 코드에서 Javadocs