3장에서는 유용한 주석을 언제 어떻게 쓰는지 배웠습니다. 너무 사소해보일 수도 있습니다. 나중에는 컴파일러가 삭제해버리는데 누가 신경이나 쓰겠어요?

하지만 전혀 그렇지 않습니다! 훌륭한 주석은 코드 기반을 더 읽기 쉽고 이해하기 쉽게 만듭니다. 향후 유지보수에 도움이 되는 매우 좋은 방법입니다. 물론 정말 필요한 곳에 실제로 도움이 되는 방식으로 넣어야겠죠.

그래서 3장에서는 맨 먼저 주석을 언제 사용하고 언제 제거해야 하는지 살펴보았습니다. 불필요한 주석뿐만 아니라 주석 처리된 코드도 없애는 것이 낫다고 배웠습니다. 어쨌든 버전 관리 도구에 보관되니까요. 상수나 유틸리티 메서드로 추출해 주석을 코드로 변환하는 방법도 배웠습니다. 이렇게 하면 컴파일러의 지원을 더 받을 수 있습니다.

그렇다고 주석 삭제만 다룬 것은 아닙니다! 구현 관련 디자인 결정이나 정규식 등을 설명할 때 제3자에게 도움이 되도록 설명서 구성법도 배웠습니다.

설명서에도 규칙이 있으므로 JavaDoc을 활용해 잘 문서화된 패키지와 인터페이스, 메서드를 만드는 방법을 보여드렸습니다.

아직 갈 길이 멉니다! 앞에서 보았듯이 규칙은 쉽게 이해할 수 있는 설명서를 작성하는 데 도움이 됩니다. 하지만 모든 변수를 x, y, z처럼 명명하면 여전히 혼동되겠죠. 학창시절 수학 수업처럼요. 4장에서는 자바 개발자가 쉽게 이해할 수 있도록 코드 구조에 좋은 이름을 할당하는 방법을 보여드리겠습니다.