package-info.java

요새 산출물로 자바 도큐먼트를 만드는 경우가 많다.

개발하기도 바뿐데 코딩하면서 주석도 달기 귀찮긴 하지만 

워드로 산출물을 만드는것보다 훨씬 경제적이고 덜 노가다? 가 필요해서 좋은것 같다.

기본적으로 자바문서를 만들면 패키지 까지는 주석이 달려나올 수가 없다.

어느정도 노가다가 좀 필요한데 방법을 설명 해보기로 한다.

참고로 자바문서를 위해 주석은 

/**  이것은 클래스 **/

class Sample{

/** 변수 */

private String name;

}

 이런식으로 클래스나 메소드 변수명 위에 써주면 된다.

이제 부터 문서도구 만드는 예제를 설명하겠다.

1.자바 프로젝트 생성

3개의 패키지를 만들고 각각의 패키지에 클래스를 만든다.

2.패키지 설명 파일 생성

각각의 패키지에서 일반 파일을 생성하고 이름을 package-info.java 로 만든다.

패키지 우클릭 - New - File - package-info.java 생성.

3.패키지 수석달기

패키지 마다 package-info.java 파일을 열고 아래와 같이 해당 패키지명을 입력한다. 

각각의 파일들에 다 입력한다.

4.자바문서생성

패키지 단위로 설명이 나오는것을 확인 할 수 있다.

질문은 댓글 환영합니다~

[출처] 자바문서 - 패키지 주석 달기|작성자 아유