[Clean Code] TIL - Day 08

Day 08

🔖 오늘 읽은 범위 :  4장 주석 (p.68~p.83)

---

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

• 나쁜 코드에 주석을 달지 마라. 새로 짜라.(p.68)
• 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.(p.68)
• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.(p.69)
• 진신을 한 곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.(p.69)
• 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!(p.69)
• 명심하기 바란다. 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!(p.70)
• 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.(p.73)
• 때로는 '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다.(p.74)
• 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다.(p.83)

🤔 오늘 읽은 소감과 떠오르는 생각

주석은 정~말 알려야 하는 사실이 아니면 오해와 혼동을 초래하기 때문에 최대한 지향을 하는 것을 알게 됐다.

사실 나는 코드를 작성하면서 주석을 많이 사용하는 편(코드 외에 주석이나 지저분한(?)것들을 싫어함)이 아니라서 '내가 잘하고 있던 걸까?'라는 생각이 들었다. 그래도 내용에서 본 경고를 알리거나 TODO를 적어 두는 둥 유용한 목적으로 사용되는 주석도 있다는 것을 알게 되었다.

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용

x

소감 3줄 요약

• 나쁜 코드에 주석을 달지 마라. 새로 짜라.
• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
• 진신을 한곳에만 존재한다. 바로 코드다.