클린코드 TIL #06

클린코드 TIL #06

DAY 06

📓 오늘 읽은 범위

• 04장 주석

---

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

• 주석은 쉰들러 리스트가 아니다. 주석은 ‘순수하게 선하지'목하다. 사실상 주석은 기껏해야 필요악이다. (p.68)
• 진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다. (p.69)
• 주석은 나쁜 코드를 보완하지 못한다. (p.69)
  • 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
• 코드로 의도를 표현하라! (p.69)
• 좋은 주석 (p.69)
  • 명심하길 바란다. 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!
  • 법적인 주석 / 정보를 제공하는 주석 / 의도를 설명하는 주석 / 의미를 명료하게 밝히는 주석 / 결과를 경고하는 주석 / 중요성을 강조하는 주석
• 나쁜 주석 (p.75)
  • 주절거리는 주석 / 같은 이야기를 중복하는 주석 / 오해할 여지가 있는 주석 / 의무적으로 다는 주석 / 이력을 기록하는 주석 / 있으나 마나 한 주석 / 무서운 잡음 / 함수나 변수로 표현할 수 있다면 주석을 달지 마라 / 닫는 괄호에 다는 주석 / 공로를 돌리거나 저자를 표시하는 주석 / 주석으로 처리한 코드 / HTML 주석 / 전역 정보 / 너무 많은 정보 / 모호한 관계 / 함수 헤더

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

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

• 팀플을 할 때마다 내 코드를 설명하기 위해서 너무나 많은 주석을 달았던 경험이 있다. 그리고 나 뿐만 아니라 다른사람도 자신의 코드를 알리기 위해서 많은 주석을 달았고, 나 또한 그것을 보고 그 함수가 의미하는 바를 알 수 있었다.
• 접근이 잘못된 것이다. 함수를 깔끔하게 작성하지 않으니 주절주절 쓸모없는 미사여구로 우리의 함수를 포장하려 했던 것이다. 클린코드 덕분에 주석의 무서움에 대해서 알게 되었다.
• 내가 쓰려는 주석이 정말로 필요한 주석인지, 꼭 써야한다면 무었때문에 존재해야하는 지 다시 한번 생각하게 되는 챕터였다.

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

• 쉰들러 리스트
  • 쉰들러가 유대인들을 안전한 곳으로 피신시키기 위해서 작성했다는 명단 아홉 개
• Javadoc
  • Java 소스 코드에서 HTML 형식의 API 문서를 생성하기 위해 Java 언어를 위해 Sun Microsystems에서 작성한 문서 생성기