3.10 생성자를 JavaDoc으로 구조화하기
class Inventory { List<Supply> supplies; /** * 새 Inventory의 생성자 */ Inventory() { this(new ArrayList<>()); } /** * 새 Inventory의 또 다른 생성자 * * 제품을 Inventory에 추가할 수 있는 생성자 */ Inventory(Collection<Supply> initialSupplies) { this.supplies = new ArrayList<>(initialSupplies); } }
자바에는 의미 있고 알맞은 이름을 할당할 수 없는 특수한 메서드 유형이 하나 있습니다. 바로 생성자입니다. 생성자명은 무조건 클래스명과 같아야 합니다. 다른 메서드보다 목적이 더 확실하지만(생성자는 항상 객체를 생성합니다) 잘못 사용하면 객체에 문제가 생깁니다. 그래서 JavaDoc 주석은 생성자에 대해 의미 정보를 적절히 설명해야 합니다.