클린 코드[Clean Code] TIL #5. 주석

DAY 5 - 22/04/28
오늘 읽은 범위 : 4장. 주석

---

책에서 기억하고 싶은 내용

• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.( p. 68 )
• 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요없는 방향으로 에너지를 쏟겠다.( p. 69 )
• 이해가 안 되어 다른 모듈까지 뒤져야하는 주석은 독자와 제대로 소통하지 못하는 주석이다. ( p. 76 )
• 모든 함수에 Javadocs를 달거나, 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지 없다. ( p. 80 )
• 주석으로 처리된 코드는 다른 사람이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안된다고 생각한다. ( p.86 )

---

오늘 읽은 소감? 떠오르는 생각

해당 장에서는 주석을 잘 다는 법을 설명한다. 어떻게 보면 주석을 달지말고 제대로 코드를 짜라고 혼내는 것 같다.

 

회사에서 기존 코드에서 모듈을 떼내서 용도를 변경하는 작업을 진행할 일이 생겨서, 코드를 이전하면서 변수명도 읽기 쉬운것으로 바꿔보고 메서드 배치 순서도 변경하는 등 여러 리팩토링 과정을 혼자서 연습해봤다.

 

이 과정에서 스스로 이해가 안되는 메서드에 주석을 달기 시작했는데, 해당 장을 읽고 나서 주석을 살펴보니 거의 대부분의 메서드에 주석을 달아놓은 상태였다.

 

주석을 왜 달려고 했을까 생각해봤는데, 읽는 사람이 이해하기 편했으면 좋겠다는 마음으로 달았던 것 같다.

 

하지만 이 주석이 누군가에게는 오히려 이해를 방해할 수도 있겠구나 하는 생각이 들었다.

나만 이해할 수 있는 문장으로 적어놓은 주석들도 몇 개 있었다. 그런 주석은 과감하게 지워버렸다.

 

책을 읽으면서 느끼는 거지만 정말 왜 개발자들의 기본서인지 알 것 같다.

코드를 작성할 때 메서드 명, 변수 명, 배치 등 다양한 것들에 세심한 주의를 기울여서 짜게되는 습관을 들일 수 있도록 도와준다.

 

한 걸음 발전하는 개발자가 되도록 이후 장들도 열심히 읽어야 겠다.

---

궁금하거나, 잘 이해되지 않는 내용

- 없음