4장 주석

TIL (Today I Learned)

2022-02-23

나쁜 코드에 주석을 달지 마라. 새로 짜라. -브라이언 W.커니핸, P.J.플라우거

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

잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.

-우린는 코드로 의도를 표현하지 못해,그러니까 실패를 만회하기 위해 주석을 사용한다.

-그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 상황을 역전해 코드로 의도를 표현할 방법은 없을까?

-주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

-코드는 변화하고 진화한다. 그래서 주석은 코드에서 분리되어 점점 더 부정확한 고아로 변하는 사례가 너무도 흔하다.

⇒그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

주석은 나쁜 코드를 보완하지 못한다.

-코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 그래서 주석을을 다는데 아니다!!! 코드를 정리해야한다.!

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

-자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!

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

경험이 많지 않아 많은 공감은 안되었지만 주석을 최대한 달지 않고 변수와 코드로 표현할 수 있게끔 시간을 투자해야 겠다고 생각이 든다.

이 부분은 다른사람의 감상평을 많이 본 후 경험에 빗대어 적으신 분을 찾아 읽으며 간접 경험이하도 해봐야 겠다.

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