클린코더스, form 좋은 주석을 위하여

필요 없는 주석은 달지 말라

• 소스코드를 읽는 사람이 짜증나게 만드는 주석을 달지 말라.
• 만든이, 변경로그 등 커밋 로그를 통해 나타낼 수 있는 내용
• 메서드 및 인자에 대한 필요 없는 설명 -> 소스코드 자체가 주석이 되도록 코드를 작성한다!

필요한 주석만 제한적으로 달라

• 소스코드를 읽는 사람이 감사함을 느낄 수 있는 상황에만 작성한다.
• 가능하면 주석을 작성하지 말고 코드를 잘 짜서 그 자체가 주석이 될 수 있도록 한다.
• 만약 작성한다면 아래와 같이 제한적인 상황에서 사용한다.
  • 법률적 문제
  • public api
  • TODO