[Java] doc

JavaDoc 파일 만들기 연습

  • 클래스가아닌 인터페이스에 작성
package kr.or.ddit.basic;

// JavaDoc 파일 만들기 연습
// /** 엔터

// html태그를 쓸수있다. @:작성자

/**
 * 
 * @author PC-21
 * @version 1.0
 * <p>
 *  
 *  파일명: JavaDocTest.java<br>
 *  설 명 : JavaDoc문서 작성을 위한 연습용 Interface<br><br>
 *  
 *  - 수정 이력 <br>
 *  ----------------------------------------------<br>
 *  수정 일자 : 2021-11-23<br>
 *  작성자: 홍길동<br>
 *  수정내용: 최초 생성<br>
 *  ----------------------------------------------<br>
 *  
 * </p>
 *
 */
public interface JavaDocTest {
	
	/**
	 * 메서드명: methodTest<br>
	 * 설 명: 반환값이 없는 메서드<br>
	 * 
	 * @param a 첫번째 매개변수(정수형)
	 * @param b 두번째 매개변수(정수형)
	 * 
	 */
	
	public void methodTest(int a, int b);
	
	/**
	 * 반환값이 있는 메서드는 @return가 자동으로 들어감 <br>
	 * 메서드명: methodAdd<br>
	 * 설명 : 반환값이 있는 메서드<br>
	 * 
	 * @param x 첫번째 매개변수(정수형)
	 * @param y 두번째 매개변수(정수형)
	 * @return 처리된 결과를 정수형으로 반환한다.
	 */
	 
	public int methodAdd(int x, int y);
	
	/**
	 * 반환값은 있지만 매개변수가 없다.
	 * 메서드명: methodSub<br>
	 * 설명 : 매개변수가 없는 메서드
	 * 
	 * @return 정수형값 반환
	 */
	public int methodSub();
	
}

export - javaDoc



좋은 웹페이지 즐겨찾기