[클린코드] 4. 주석

주석

주석은 순수하게 선하지 못하다. 사실상 주석은 기껏해야 필요악이다.

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

그러므로 주석이 필요한 상황에 처하면 코드로 의도를 표현할 방법은 없을까 곰곰히 생각해보아야 한다.

코드는 변화하고 진화한다. 하지만 불행하게도 주석은 언제나 코드를 따라가지 않는다. 아니, 따라가지 못한다.

그래서 코드를 읽는 사람에게 더욱 더 혼란을 주고 해악을 미친다.

진실은 코드에만 존재한다. 코드만이 정확한 정보를 제공하는 유일한 출처다.

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

 

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

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

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

 

코드로 의도를 표한하라!

확실한 코드만으로도 의도를 설명하기 어려운 경우가 존재한다.

불행히도 많은 개발자가 이를 코드는 휼륭한 수단이 아니라는 의미로 해석한다.

이는 잘못된 생각이다. 몇 초만 더 생각해면 코드로 대다수 의도를 표현할 수 있다.

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

 

좋은 주석

정말로 좋은 주석은 주석을 달지 않게 만드는 주석이다

• 법적인 구현 표준에 맞춰 법적인 주석
• 기본적인 정보를 제공하는 주석
• 의도를 분명히 설명하는 주석
• 의미를 명료하게 밝히는 주석
• 결과를 경고하는 주석
• TODO 주석
• 중요성을 강조하는 주석

위처럼 좋은 주석도 있지만 최대한 주석을 달지 않는 방법을 생각해보아야 한다.

 

나쁜 주석

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

일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.

• 독자와 소통하지 못하는 주석
• 같은 이야기를 중복하는 주석
• 오해할 여지가 있는 주석
• 의무적으로 다는 주석
• 있으나 마나 한 주석
• 위치를 표시하는 주석
• 주석으로 처리한 코드

도움이 되지 않는 주석을 많이 작성하다 보면 개발자는 주석을 무시하는 습관이 생긴다.

결국 코드가 바뀌면서 주석은 거짓을 설명하고 있는 셈이다.

함수나 변수로 표현할 수 있다면 주석을 달지 않는 것이 좋다.