문서화 주석

공개된 API요소에는 항상 문서화 주석을 작성하라 - [8장. 메서드(아이템56)]

📙 1. 문서화 주석 작성 방법 자바에는 소스코드 파일에서 문서화 주석(doc comment; 자바독 주석)이라는 특수한 형태로 기술된 설명을 추려 API 문서로 변환하여 보여주는 자바독이 있다. 문서화 주석을 작성하는 규칙은 '문서화 주석 작성법(How to Write Doc Comments)'에 기술되어 있다. 해당 문서에 더해서 추가적으로 알아야 하는 내용은 아래와 같다. API를 올바로 문서화하려면 공개된 모든 클래스, 인터페이스, 메서드, 필드 선언에 문서화 주석을 달아야 한다. 직렬화할 수 있는 클래스라면 직렬화 형태에 관해서도 적어야 한다. 기본 생성자에는 문서화 주석을 달 방법이 없으니 공개 클래스는 절대 기본 생성자를 사용하면 안 된다. 유지보수까지 고려한다면 대다수의 공개되지 않은 클래..