[클린코드] 4장. 주석

이 글은 클린 코드를 읽고 좋은 구절들을 기록하거나 느낀 점을 기록하는 글입니다.

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

코드를 작성하다 주석을 사용할 때는 다른 사람 또는 내가 코드를 볼 때 알아보기 힘들 거 같다고 예상이 들면 주로 주석을 작성한다. 사실 이건 주석으로 때우려고 하지 말고 코드를 고쳐야 하는 것이 맞다 하지만 역시 주석을 달고 도망가버리곤 했다..

좋은 주석

TODO 주석

가끔 코드를 보다보면 //TODO 주석을 본 적이 있다. 말 그대로 필요하지만 당장 구현하기 어려운 일들을 기술하는 주석이다. 더 이상 필요 없는 기능을 삭제하라거나 더 좋은 이름을 생각해달라는 부탁 앞으로 어떻게 고쳐야 한다는 주의 등에 유용하다.

나쁜 주석

대다수의 주석들이 나쁜 주석들이다. 물론 아닌 사람도 있겠지만 주석들은 코드가 부실할 때 많이들 사용하기 때문이다. 책에 나오는 나쁜 주석의 예들은 내가 와닿는 것은 크게 없다. 

 

주석을 최대한 사용하지말고 코드로 나타내야 하는 것 같다. 그렇다고 무조건 안 써야 지는 아니고 적당히 필요한 곳에서 사용해야 한다. 주석에 의존하지 말고 주석을 사용할 정도면 코드를 수정하라는 뜻으로 받아들여야겠다.