• 우리는 책임 있는 프로그래머로서 코멘트를 잘 달아야 할 의무가 있다.
  • 코멘트가 필요없을 정도로 좋은 코드(스스로 문서화 하는)를 작성하라.
  • 코드를 묘사하지 말고, 왜에 대해서 설명하는 코멘트를 작성하라.
  • 과거에 무엇을 했는지 기록하지마라. 그것은 리비전 컨트롤 시스템이 알아서 할 것이다.
  • 나쁜 코드는 문서화하지 말고 다시 작성하라.
  • 명료하고 일관성있게 작성하라.
  • 하나의 사실은 한 곳에만 작성하라.
  • 코멘트는 과거가 아니라 현재 속에서 살아야 한다. 코드가 바뀌었다거나 예전에 뭐가 어땠었다는 기술은 하지 마라.
  • 코드를 변경할 때 그 주변에 있는 코드도 모두 유지보수하라.

Agile 관련 책에서도 유사한 내용이 나오지만 코멘트는없으면 없을 수록 좋다. 코드만으로도 이해할수 있는 코드가 가장 좋기 때문이다.

그렇지 못하다면 위에서 처럼 코드와 똑같은 내용을 문장으로 적는 것이 아니라 알고르즘이나 코드의 존재 이유에 대해 적어야 한다. 불필요한 코멘트는 코드의 가독성만 떨어뜨린다.

출처 : birdkr’s home by (버드)

, ,