[클린코드] 4장 - 주석

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

•  주석은 '순수하게 선하지' 못하다. 사실상 주석은 기껏해야 필요악이다.
• 주석은 언제나 실패를 의미한다. 때때로 주석없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다. 
• 주석은 오래 될 수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다.
• 불항하게도 주석이 언제나 코드를 따라가지 않는다. 
• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
• 진실은 한곳에만 존재한다. 바로 코드다. 코드만 자기가 하는일을 진실되게 말한다.
• 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

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

코드로 의도를 표현하라

좋은 주석

• 법적인 주석
  • 각 소스파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.
• 정보를 제공하는 주석
  • 기본적인 정보를 주석으로 제공하면 편리하다.
  • 가능하다면 ㅎ마수 이름에 정보를 담는 편이 더 좋다.
• 의도를 설명하는 주석
• 의미를 명료하게 밝히는 주석
• 결과를 경고하는 주석
• TODO 주석
  • 앞으로 할일을 TODO주석으로 남겨두면 편하다.
  • TODO 주석은 프로그래머가 필요하다 여기까지만 당장 구현하기 어려운 업무를 기술한다.
• 중요성을 강조하는 주석
  • 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.

나쁜주석

• 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
• 주절거리는 주석
  • 특별한 이유없이 의무감으로 혹은 프로세스에서 하라고하니까 마지못해 주석을 단다면 전적으로 시간낭비다.
  • 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.
• 같은 이야기를 중복하는 주석
• 오해할 여지가 있는 주석
• 의무적으로 다는 주석
  • 모든함수에 javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지 없다.
• 이력을 기록하는 주석
  • 모든 모듈 첫머리에 변경이력을 기록하고 관리하는 관례가 바름직했다. 당시에는 코드 관리 시스템이 없었으니까. 이제는 혼란만 가중할 뿐이다.
• 있으나 마나 한 주석
  • 너무 당연한 사실ㅇ을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
• 위치를 표시하는 주석
• 닫는 괄호에 다는 주석
• 공로를 돌리거나 저자를 표시하는 주석
  • 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 저자 일므으로 코드를 오염시킬 필요가 없다.
• 주석으로 처리한 코드
  • 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.
  • 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리 할 필요가없다. 그냥 코드를 삭제하라. 
• HTML주석
  • 소스코드에서 HTML주석은 혐오 그 자체이다.
• 전역정보
  • 주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템 전반적인 정보를 기술하지 말아라.
• 모호한 관계
  • 주석과 주석이 설명하는 코드는 둘사이 관계가 명백해야한다.
• 함수 헤더
  • 짧은 함수는 긴 설명이 필요없다.