[CleanCode] 주석

CleanCode - 주석

잘 달린 주석은 그 어떤 정보보다 유용합니다. 

 

하지만 책에서는 주석에 대해 부정적으로 표현하는 것 같습니다. 

보통 주석을 아래와 같이 표현합니다.
- 경솔하고 근거없는 주석은 코드를 이해하기 더 어렵게 만든다.
- 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.

이렇게 생각하는 이유는 주석은 나쁜 코드를 보완하지 못한다고 생각하기 때문입니다.

일반적으로 주석을 추가하는 이유는 코드 품질이 나쁘기 때문이라고 합니다.
자신이 저지른 안 좋은 코드를 감추기 위해 보통 주석을 단다고 합니다.

그리고 그렇게 주석을 다는 대신 코드를 다시 잘 짜는데 시간을 보내라고 팩트를 말합니다.
'주석 대신 코드로 의도를 표현하라. 잘 짜여진 코드와 함수명이면 충분하다.'

책에서 말하는 몇 가지 좋은 주석의 예
- 법적인 주석
- 의도를 설명하는 주석
- 결과를 경고하는 주석
- TODO 주석

책에서 말하는 몇 가지 나쁜 주석의 예
- 주절거리는 주석
- 같은 이야기를 반복하는 주석
- 있으나마나 한 주석
- 이력을 기록하는 주석
- 주석으로 처리한 코드

이러한 내용을 바탕으로, 반드시 필요하지 않다면 주석을 달지 않는 것을 추천하고 있습니다.

마무리
책에서는 주석의 존재를 조금은 부정적으로 말하는 경향이 큰 것 같습니다.

 

하지만 몇 가지 좋은 주석의 예도 설명해주고있고, 실제로 적절한 주석은 코드를 읽을 때

 

많은 도움이 될 수 있다고 생각합니다.