노마드코더 북클럽 클린코드 TIL 네번째

2022년 4월 29일 TIL

오늘 TIL 3줄 요약

사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라 (p.103)
주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 이유는 단순하다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까. (p.103)
나라면 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다. (p.104)
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라! (p.104)
닫는 괄호에 주석을 달아야겠다는 생각이 든가면 대신에 함수를 줄이려 시도하자. (p.120)
주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다. (p.121)

많이 동의하는 내용이다. 주석이 잔뜩 달려있어도 관리되지 않는 주석이 태반인 경우가 많다.
주석 처리된 코드는 관련 부분에서 문제가 발생했을 때, 왠지 주석을 풀면 해결될 것 같은 착각을 갖게할 때가 있다. 물론, 주석을 풀면 코드 구조가 바뀌었기 때문에 주석잡혔던 코드가 제대로 동작할리가 없다.
닫는 괄호와 비슷하게 C++의 #if ~ #endif 나 #define ~ #undef 로 구성된 블럭에 닫는 쪽에 주석을 붙이고 있는 편이다. 괄호는 들여쓰기로 어느정도 구분이 되지만 이건 구분이 어렵다.