[클린 코드] 4장. 주석

2022. 02. 25

 

 

📚 오늘 읽은 범위

4장. 주석

 

 

📖 책에서 기억하고 싶은 내용

- 나쁜 코드에 주석을 달지 마라. 새로 짜라. (p.68)

- 진실은 한 곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다. (p.69)

- 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. (p.69)

- 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다. 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다. (p.70)

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

 

 

🙌 오늘 읽은 소감

- 내가 처음 프로그래밍을 배울 당시에는 주석을 자세히 달아라!라고 배웠었는데 나는 그게 습관이 잘 안 들어서 아직까지도 주석을 많이 달지 않고 좀 함수나 변수명을 구구절절 만드는 편이었다. 내가 하는 방법이 나쁜 방법은 아니었음을 알게 되어서 좋았다. 

- 지금 달아 놓았던 몇 안 되는 주석들도 더 깔끔하게 처리할 수 있다니...! 새로운 시각으로 코드를 볼 수 있게 되었다.