[클린코드] 4장 주석

Clean Code

 

 

진실은 한곳에만 존재한다.
바로 코드다.
코드만이 자기가 하는 일을 진실되게 말한다.
코드만이 정확한 정보를 제공하는 유일한 출처다.

 

 

✏️ 기억하고 싶은 내용

• 나쁜 코드에 주석을 달지 마라. 새로 짜라.
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라.
• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고. 중요하니까 지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다.

 

💡 떠오르는 생각

의무감으로 주석을 달았던 적도 있고, 코드를 보고 바로 이해가 되지 않아서 주석을 남겨 놓은 적도 있다. 이 코드가 언제 다시 쓰일지 몰라서 일단 주석 처리해놓은 적도 있다. 이 모든 것들이 책에서 언급이 되었다.

주석처리가 된 코드는 혼란을 가져온다. 주석이 된 이유도 있겠다. 모든 코드는 다 기록에 남아있으니 쓸데 없이 코드를 주석 처리를 해서 남겨놓지 말자. 그렇게 묵혀지고 혼란만 가져올 것이다.

사실 코드도 언어이기 때문에 우리가 평소에 말을 하듯이 변수 명과 함수 명을 잘 활용한다면 주석을 써놓을 필요도 없을 것이다. 코드를 이야기처럼 풀어나가야 함을 생각해보았다.

수 많은 라인의 코드 속 단 한 줄의 주석은 주목을 받겠지만, 수도 없이 많은 주석은 하나하나 다 주목을 받지 못할 것이다. 양치기 소년이 떠올랐다. 그렇게 수 많은 주석 속 정말 중요한 단 하나의 주석은 수많은 주석에 이미 무감각해진 사람에게는 그저 지나가는 하나의 주석일 뿐이다. 주석에 무감각해지지 않게 꼭 필요한 주석만 달자. 나머지는 코드를 명쾌하게 짜서 주석을 달 필요가 없게 하자.