[JAVA] 문서 주석(javadoc) 사용 법

문서 주석이란?

•  
• Java 클래스 및 패키지를 문서화 하기 위한 주석
• 클래스의 용도와 사용법 등을 설명하는 규칙
• 자동으로 JavaDoc 문서를 생성할 수 있음
• 클래스, 메소드 자동완성 기능 호출시 어떤 정보인지 확인 가능
• 사용된 클래스, 메소드에 마우스를 올렸을때 어떤 정보인지 확인 가능

"/**      */"에 의해 경계가 결정되는 것을 '문서 주석'이라 하는데, javadoc 툴을 이용하여 HTML파일로 축출한다

/**
 * 
 * @author dev-truly // 개발자 정보
 *
 */
public class Employee {
	private static int employeeCnt = 0;
	String name;
	double salary;
	/**
	 * @param name		// 전달 파라미터1
	 * @param salary	// 전달 파라미터2
	 */
	public Employee(String name, double salary) {
		this.name = name;
		this.salary = salary;
		employeeCnt++;
	}
	/**
	 * @param name // 이름
	 * @return String //리턴값 설명  
	 */
	public String javaDocs(int name) {
		return "안녕";
	}
	
	public void showEmployeeInfo () {
		System.out.printf("사원 이름 : %s, 사원 급여: %.1f\n", name, salary);
	}
	
	public static void showEmployeeCnt () {
		System.out.printf("현재 사원 수 : %d", employeeCnt);
	}
	
	public void finalize() {
		employeeCnt--;
	}
}

클래스 호출 전 노출 정보

생성자 정보 기본 호출 전 설명 화면

문서주석 사용에 사용되는 블럭주석의 종류

@author 이름	클래스나 인터페이스의 제작자 표시
@version 테스트	클래스나 인터페이스에서의 버전 정보
@param 매개변수 - 이름 설명	매개 변수에 대한 설명
@return 설명	메소드가 void를 리턴하거나 생성자가 아닌 경우를 제외하고 모두 사용해야 함
@exception or @throws	메소드가 발생시킬 수 있는 예외를 기술
@deprecated	다음 버전에서 폐기된 메소드를 알림
@serial	기본적으로 직렬화 할 수 있는 클래스의 멤버를 설명
@see	- 어떤 클래스, 인터페이스, 메소드, 생성자 혹은 URL에 대한 전후 참조 표시  - 분리된 줄에 링크가 생김
@since	Tag를 가진 객체가 언제 추가되었는지 명시
{@link #entity label}	메소드나 필드의 상호 참조에 대한 링크를 표시 문서 텍스트 안에 링크가 생김
{@doc-root}	문서에 대한 루트디렉토리에 대한 상대경로 지정