11. 주석 - 유지보수와 변경의 정확성을 높이는 주석 작성 방법

내용

---

내용이 낡은 주석

• 코드에 비해 주석을 유지 보수하는 것이 어렵다

• 주석은 실제코드가 아니다.

  • 그러므로 클래스, 메서드 이름을 최대한 의도를 전달할 수 있도록 짓고, 주석을 달아야함

• 로직의 동작을 설명하는 주석은 낡기 쉬움.

• 의도와 사양 변경 시, 주의사항을 읽는 이에게 전달하기

  • 주석은 아래 내용을 담는 것이 좋을듯,

    • 이 로직은 어떤 의도를 갖고 움직이는 가

    • 안전하게 변경하려면 무엇을 주의해야 하는가

• Javadoc

정리

---

• 주석은 아래 내용을 담는 것이 좋을듯,

  • 이 로직은 어떤 의도를 갖고 움직이는 가

  • 안전하게 변경하려면 무엇을 주의해야 하는가

• Javadoc

참고

---

• https://product.kyobobook.co.kr/detail/S000202521361