기본 API 클래스 - API문서작성

API (Application Programming Interface) 란!!!!!!!!!

구현되어있는 기능을 가진 클래스 또는 인터페이스를 제공해주는 모음집 뜻한다.

API 의기능을 설명해주는 문서는 자기가 직접 만들 수도 있다.

package exam.codedoc;

/**
 * 학생 정보를 담는 클래스이다.
 * 
 * @author javaStudy
 * 
 * 
 */
public class Student {
/**
 * 학생 이름
 */
	private String myName;
	/**
	 *학생 나이 
	*/
	private int age;
	/**
	 * 학생 이름을 변환하는 메서드
	 * @return myname
	 * 
	 */
	public String getMyName() {
		return myName;
	}
	
	/**
	 * 학생 이름을 등록하는 메서드
	 * @param myName
	 */
	public void setMyName(String myName) {
		this.myName = myName;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	
}

/**

*/

/** -> 별두개쓰면 document 주석이다.

코드를 다음과 같이 작성한 후 project -> generate document 

이후 VM option 에서 인코딩을 맞춰줘야한다.

이클립스가 쓰는 인코딩은 UTF-8이므로

-encoding UTF-8 docencdoing UTF-8 을적은 뒤 fisnish

그이후 작업폴더에가서 index.html을 눌러주면 본인이 작성한 문서가 나온다.