JavaDoc 만드는 방법

■ JavaDoc 만드는 방법

1. JavaDoc을 만들 Class에 주석 및 @author 추가

/**
 * 클래스에 대한 설명, 이 클래스는 JavaDocs 클래스를 공부하기 위해...
 * @author  Yoon Seok
 */
public class JavaDocs {
    ...
}

 

 

2. 설명할 Constructor, Method 등에 주석을 달아준다.

/**
 * 생성자에 대한 설명
 * @param memberInt 입력 1
 * @param memberString 입력 2
*/
public JavaDocs(int memberInt, String memberString) {
	this.memberInt = memberInt;
	this.memberString = memberString;
}

/**
 * 메소드에 대한 설명
 * @param string 입력 인자 (파라미터)에 대해 설명
 * @return 리턴에 대한 설명
*/
public int methodA(String string){
	return  Integer.parseInt(string);
}

 

 

3. Tools -> Generate JavaDoc...(Intellij)

 1) Generate JavaDoc Scope : JavaDoc을 만들 파일 선택

 2) Output Directory : JavaDoc이 저장될 위치

 3) Other command line arguments : 실행시킬 Command 입력 ( "-encoding UTF-8" 추가 )