더북(TheBook)

훨씬 나아졌습니다. 마치 계약서를 읽듯 JavaDoc 주석이 읽힙니다. 입력과 내부 상태가 특정 출력과 상태 변경을 어떻게 보장하는지 명시합니다.

위 계약은 설명과 코드 예제로 만든 훌륭한 사례입니다. <pre>는 XML 환경이므로 <pre>< 문자를 반드시 &lt;로 탈출시켜야 합니다.

심지어 null처럼 유효하지 않은 입력까지도 @param 설명에 명시하면서 위반 시 NullPointerException@throws한다고도 언급했습니다.

그뿐만 아니라 @see 표기로 다른 메서드도 참조합니다. 메서드가 일으킨 효과를 되돌리는 방법이나 메서드 호출로 야기된 상태 변화를 관찰할 수 있는 방법을 설명합니다.

다만 계약서 비유가 꼭 들어맞는 것은 아닙니다. 구현과 명세가 다르다는 이유로 누군가를 고소할 수는 없으니까요.

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.