[클린코드 리뷰] 4장. 주석

* 개발 도서 리뷰 게시물은 책을 요약해둔것이 아닌, 책을 읽고 독자인 제가 깨달은 점, 받아들인 점을 작성한 글입니다.

 

나는 여태까지 코드를 짤 때 주석을 상세히 작성하는게 매우 중요하다고 생각했다. 다음에 코드를 다시 마주했을 때 이해하기도 편하고 코드를 읽지 않고도 의도를 이해할 수 있었기 때문이다.

그러나 이 책에서는 주석은 필요악이라는 표현을 썼다. 

코드에서 의도를 제대로 표현하지 못해서 주석에 주저리주저리 내용을 작성하는 것이기 때문이다.이제 버전관리 프로그램도, IDE도 너무나 발전했기 때문에 주석에 이력 남기기와 같은 행위는 필요 없어졌고, 정확하지 않는 변수명을 주석으로서 보충하는 것도 시간이 흘러 의도가 변할 수 있다. 물론 시스템을 구현하는데 근거가된 정책, 프로그램을 구동하는데 알아야할 참고사항과 같이 꼭 필요한 주석도 있다. 하지만 이렇게 꼭 필요한 경우를 제외한 주석들은 필요가 없다.. 

내가 여태까지 코드에 의도를 표현하는 것과 코드를 읽는 것에 있어서 매우 게을렀구나 라는 생각을 했다. 이걸 이제서야 알았다니 아쉬운 마음이 들었다.

그래서 이제라도 주석 사용을 최소화하기 위해 함수를 쪼개고 함수와 변수에 좋은 이름을 부여하여 주석없이도 쉽게 이해할 수 있는, 코드 자체로 설명이 되는 코딩을 해야겠다고 생각했다.

또한, 2,3 장에서 변수 명과 함수 명을 자세하게 쓰는 것을 강조한 이유가 이해되었고 4장의 내용으로써 완벽히 설득되었다!