2.7.2 클래스 주석
클래스 주석은 반드시 클래스 선언 바로 앞에 붙여야 한다. @author와 @version 태그로 저자와 버전을 문서화할 수 있다. 여러 사람을 저자로 넣을 수도 있다.
다음은 클래스 주석의 예다.
/**
* <code>Invoice</code> 객체는 각 주문 항목에 해당하는
* 품목을 나열한 청구서를 표현한다.
* @author 프레드 프린스톤
* @author 바니 러블
* @version 1.1
*/
public class Invoice {
...
}
Note ≣
모든 줄 앞에 *를 넣을 필요는 없다. 하지만 대부분의 IDE는 자동으로 *를 추가하며, 심지어 그중 일부는 줄이 바뀔 때 재배치하기도 한다.