클린 코드 - 4장 주석

범위

• 4장 주석

요약

• 나쁜 코드에 주석을 달지 마라. 새로 짜라.
• 주석은 기껏해야 필요악이다.

책에서 기억하고 싶은 내용

• 나쁜 코드에 주석을 달지 마라. 새로 짜라.
• 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 - 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 - 거짓과 잘못된 정보를 퍼트릴 해악을 미친다.
• 주석은 ‘순수하게 선하지’ 못하다. 사실상 주석은 기껏해야 - 필요악이다.
• 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 - 가능성도 커진다.
• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
• 주석은 나쁜 코드를 보완하지 못한다.
• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 - 어수선한 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 - 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 - 치우는 데 시간을 보내라.
• 코드로 의도를 표현하여
• 좋은 주석
  • 주석을 달지 않은 방법을 찾아낸 주석
  • 법적인 주석
  • 정보를 제공하는 주석
  • 의도를 설명하는 주석
  • 의미를 명료하게 밝히는 주석
  • 결과를 경고하는 주석
  • TODO 주석
    • 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라
  • 중요성을 강조라는 주석
  • 공개 API에서 JavaDocs
• 나쁜 주석
  • 주절거리는 주석
  • 같은 이야기를 중복하는 주석
  • 오해할 여지가 있는 주석
  • 의무적으로 다는 주석
  • 이력을 기록하는 주석
  • 있으나 마나 한 주석
  • 무서운 잡음
  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라
  • 위치를 표시하는 주석
  • 닫는 괄호에 다는 주석
  • 공로를 돌리거나 저자를 표시하는 주석
  • 주석으로 처리한 코드
  • HTML 주석
  • 전역 정보
  • 너무 많은 정보
  • 모호한 관계
  • 함수 헤더
  • 비공개 코드에서 JavaDocs

소감

• 나도 주석 없이 코드만 읽어도 내용을 알 수 있는 코드를 짜보고 싶다!!