TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장. 주석

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

• p69 주석은 나쁜 코드를 보완하지 못한다 - 코드에 주석을 추가하는 일반적인 이뉴는 코드 품질이 나쁘기 때문이다. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기 어렵다. 지저분한 모듈이라는 사실을 자각한다. 그래서 자신에게 이렇게 말한다. "이런! 주석을 달아야겠다!" 아니다! 코드를 정리해야 한다!

• p75 나쁜 주석 - 대다수 주석이 이 범주에 속한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.

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

• 읽고 돌이켜보니 나도 거의 주석을 '변명'으로 사용했던 것 같다. 주석은 코드를 변명하는 용이 아니라는 것을 제대로 알 수 있게 되었다.

• 결국 결론은, 좋은 코드를 작성하라는 것이다.