javadoc은 java document 로 출력을 하거나 변수, 함수 또는 클래스에 마우스 오버시 설명(주석)을 표시 할 수 있도록 해준다.
변수, 함수 또는 클래스의 윗 부분에 /** 로 시작해서 */로 끝나는 주석문을 추가 한다.
자주 사용하는 인자로는
@author - 작성자
@param - 인자
@return - 반환값
@throws - 예외값
@exception - 예외 처리
등이 있다
내부 설명에서 줄 바꾸기는 <br/> 태그를 이용한다.
ex)
/**
* a 와 b 을 더한다
* a 와 b 은 int 형식 이어야 한다.
* @author Fumika
* @param a 더하기를 할 인자 a
* @param b 더하기를 할 인자 b
* @return a 와 b 를 합친 값을 반환
*/
public int plus(int a, int b) {
return a + b ;
}
'Development > Java' 카테고리의 다른 글
| 구글 플레이 게임 서비스 자동 로그인 설정 / 해제하기 (0) | 2014.06.23 |
|---|---|
| Byte Array <-> Integer (0) | 2014.05.30 |
| 제곱 구하는 방법 (0) | 2013.09.04 |
| 각도 구하는 방법 (0) | 2013.09.04 |
