더북(TheBook)

이제 JavaDoc 주석 최상단에 있는 요약문이 눈에 잘 띕니다. 인터페이스명을 똑같이 되풀이하지 않으면서 유용한 조언도 제공합니다.

이어지는 설명은 후입선출법(last-in-first-out) 사용과 같은 동작을 더 상세히 설명합니다.

더불어 인터페이스를 호출할 때 capacity에 대해 보장하는 두 가지 조건도 명시합니다. java.util.List 인터페이스나 다른 인터페이스, 그리고 상태를 갖는 클래스의 JavaDoc 주석에서도 이러한 조건을 볼 수 있는데요. 항상 참이므로 이것을 조건 불변(invariant)이라고 부릅니다.

결론적으로 인터페이스와 퍼블릭 클래스를 위한 훌륭한 JavaDoc 주석은 다음과 같이 작성하세요. 먼저 짧고 간결한 요약으로 시작하세요. 요약을 클래스나 인터페이스가 보장하는 불변과 수직으로 분리하세요. 메서드 서명을 되풀이하지 마세요.

또한 예제는 항상 도움이 됩니다! 그러니 가만히 앉아 위 인터페이스의 용법을 나타낼 예제를 만들어 보세요.

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