2020.11.11 고급자바 노트 doc 설명서 주석 라이브러리

 Doc 을 만들어서 ( 설명서를 만드는것 )

프로젝트에 오른쪽 마우스 -> Export -> Javadoc 를 선택 ->next -> 위치를 설정 -> next -> VM options 에 -charset UTF-8 -encoding UTF8 -> finish 

경로로 가서 : D:\A_TeachingMaterial\3.HighJava\workspace\javaDocTest\doc

index.html 클릭 ! 






package javaDocTest;


//javaDoc 파일 만들기 예제 


/**   // 요거 ! 

 * 

 * @author sujeong lee 

 * @version 1.0

 * 

 * <p>

 * 파일명 : JavaDocTestInf.java<br>

 * 설명 : JavaDoc 문서 작성을 위한 연습용 Interface<br><br>

 * 

 * 수정 이력<br>

 * -----------------------------------<br>

 * 수정일자 : 2020-11-11 <br> 

 * 작성자 : 이수정<br>

 * 수정 내용 : 최초 생성<br>

 *  -----------------------------------<br>

 * </p>

 *

 */



public interface JavaDocTestInf {


/**

* 메서드명 : methodTest

* 설 명 : 반환값이 없는 메서드

* @param a 첫번째 매개변수 ( 정수형 ) 

* @param b 두번째 매개변수 ( 정수형 ) 

*/

public void methodTest(int a , int b ); 

/**

* 메시드명 : methodAdd 

* 설명 : 반환값이 있는 메서드 

* @param x 정수형 첫번째 매개변수

* @param y 정수형 두번째 매개변수 

* @return 처리된 결과가 정수형으로 반환된다. 

*/

public int methodAdd(int x , int y); 

/**

* 메서드명 : methodSub

* 설 명 : 매개변수가 없는 매서드  

* @return 정수형으로 반환된다. 

*/

public int methodSub(); 

}





댓글