[노마드코더 북클럽] 클린코드 4. 주석

오늘 읽은 범위
4. 주석

책에서 기억하고 싶은 내용을 써보세요.

• 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다. (p.68)
• 진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다.(p.68)

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

• 나는 클래스나 함수의 기능을 설명하면서 중간중간 주석을 다는 편이라서 '코드로 설명할 수 있다면 주석을 굳이 달 필요가 없다'는 식의 의견이 있으리라고는 잘 생각해보지 못한 것 같다. 주석을 클린 코드의 일부분이라고 생각하지도 못했을만큼 주석의 중요성에 대해 크게 인식하지 못했었는데 앞으로는 주석을 달 때 꼭 필요한건지 좀더 주의해서 생각해봐야겠다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• 책을 읽고 회사에서 팀원분들은 어떻게 생각하시는지 여쭤봤는데 많은 분의 의견이 주석을 너무 남기지 않으면 나중에 코드를 읽을 때 후회한 적이 많다는 것이었다. 글쓴이가 현업에서 일할 때는 지금처럼 비즈니스 로직이 복잡하지 않았을 것이라는 의견도 주셨다. 우리 회사만 해도 복잡한 경우의 비즈니스 로직이 많은데 그 경우 주석이 없다면 로직을 한번에 이해하기 어려울 것이다. 팀원분들과 이야기 하면서 마냥 책의 내용을 받아들이는 것이 아니라 한번 더 비판적으로 생각해볼 수 있어서 도움이 되었다.