TIL

Chapter 14 설명하는 주석

• 코드에서 명확하지 않은 내용만 골라 주석을 작성하면 좋다.
  • 이 코드를 처음 읽는 사람을 가정해라
  • ex) 네트워크 호출 횟수를 최대한 줄여야 하므로 다소 복잡해졌습니다.

• 파일에 주석이 없는 경우 파일을 읽을 사람이 얻게될 유용함을 미리 알려주자

• 코드의 결함을 발견한 경우에도 즉시 주석을 달아야 한다.

// 새로운 경우를 한 개 더 추가하려면 .. /foo를 반드시 변경해야 한다.

• 물론 위와 같은 코드가 결합되어 있는 것은 바람직하지 않다.
• 결국 제거해야겠지만 주석을 통해 결합도 문제를 미리 지적해 두는 것이 낫다.