주석

나쁜 코드에 주석을 달지 마라 브라이언 W 커니헨 P.J 플라우저

잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거없는 주석은 코드를 이해하기 어렵게 만든다.

오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.

주석은 순수하게 선하지 못하다. 기껏해야 필요악이다.

프로그래밍 언어를 치밀하게 사용해 의도를 표현한다면 주석은 필요가 없다.

프로그래머가 주석을 유지하고 보수하기란 현실적으로 불가능 하다.

코드의 변화를 주석이 따라가지 못한다.

주석을 엄격하게 관리하기보다, 코드를 깔끄하게 정리하고 표현력을 강화하는 방향으로 짜는 것이 좋다.

저자는 애초에 주석이 필요없는 방향이 되는게 좋다고 말한다.

코드만이 정확한 정볼르 제공하는 출처이므로, 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

---

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

코드에 주석을 추가하는 일반적인 이유는 코드품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다 좋다.

난장판을 꺠긋히 치우는데 시간을 보내라!