이유

• 주석을 다는건 언제나 창작의 고통을 감내하는 것 같다. 좋은 주석이 무엇일까 고민하다가 찾은 것들을 정리한다.

• 참고 :

  • 주석을 잘쓰는 방법: 주석에 담아야하는 내용(1/2)
  • 주석을 잘쓰는 방법: 주석에 담아야하는 내용(2/2)

요약

• 코드에서 빠르게 유추할 수 있는 내용은 주석을 달지 말라
• 나쁜 이름에 주석을 달지마라 -> 이름을 고쳐라 (거지같은 이름으로 메소드를 만들어 놓고 변명하는 주석을 쓰지 마라)
• 생각을 기록하라(개발 시 중요한 통찰을 기록해야한다.)
• 코드에 있는 결함을 설명하라(훗날 수정할 거라는 생각이 드는 부분이 있으면 이러한 생각을 주석으로 작성해라)
• 상수에 대한 설명 (상수를 어떤식으로 변경해야하는지, 어떠한 제약조건이 있는지 등)
• 나올것 같은 질문을 예측해라
• 사람들이 빠질 것 같은 함정을 경고해라
• 큰그림을 알려주는 주석을 작성해라