JavaDoc 파일 만들어 보기


초기 설정 방법

<aside> 👉🏼 **/** 쓰고 Enter

그러면 이렇게 나온다.**

/**

*

* @author PC-05

*

*/

</aside>

프로그램과 메뉴얼을 같이 만드는 방법

  1. 프로젝트 생성→ 패키지 생성 → 코드 작성
package document;
// javaDoc 파일 만들기 예제 ==> 프로그램과 메뉴얼을 같이 만드는 방법

/**
 * 
 * @author 박정수
 * @version 1.0
 *
 * <p>
 * 파일명 : JavaDocTest.java<br>
 * 설 명 : JavaDoc문서 작성을 위한 연습용 interface<br><br>
 * 
 * 수정 이력<br>
 * -----------------------------------<br>
 * 수정일자 : 2023-03-17<br>
 * 작 성 자 : 박정수<br>
 * 수정내용 : 최초 작성 <br>
 * -----------------------------------<br>
 * </p>
 * 
 */
public interface JavaDocTest {
	/**
	 * 메서드명 : methodTest<br>
	 * 설 명 : 반환값이 없는 메서드
	 * 
	 * @param a 첫번째 매개변수 (정수형)
	 * @param b 두번째 매개변수 (정수형)
	 */
	public void methodTest(int a, int b);
	
	/**
	 * 메서드명 : methodAdd<br>
	 * 설 명 : 반환값이 있는 메서드<br>
	 * 
	 * @param x 첫번째 정수형 매개변수
	 * @param y 두번째 정수형 매개변수
	 * @return 처리된 결과가 정수형으로 반환된다.
	 */
	public int methodAdd(int x, int y);
	
	/**
	 * 메서드명 : methodSub<br>
	 * 설 명 : 매개변수가 없는 메서드<br>
	 * 
	 * @return 정수형으로 반환한다.
	 */
	public int methodSub();
}
  1. Export → Javadoc 선택

Untitled

  1. 아무것도 건들지 말고 Next 선택

Untitled

  1. 아무것도 건들지 말고 Next선택