Javadoc 만들기 | Javadoc 태그 | @return 태그
@return
태그는 반환 값에 대한 설명(데이터 유형 및 범위 등)을 표시 할 때 사용한다.
@return description
반환 값에 대한 설명을 표시
기술 위치 : 메소드
복수 작성 : 불가능
출력 형식 : 반환 값
메소드의 반환 값에 대한 설명을 작성한다. 사용 법은 다음과 같다.
/**
* 주석의 설명문
* @return 계산한 면적
*/
실습
간단한 예를 실습해 보도록 하겠다.
/**
* Javadoc 테스트용 클래스
*/
public class Sample12 {
/**
* 사이즈 설정
*
* @param width 폭
* @param height 높이
* @return 계산한 면적
*/
public int getSize(int width, int height) {
return width * height;
}
}
위에 소스 코드를 “Sample12.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.
$ javadoc -d doc Sample12.java
생성된 “doc” 디렉토리에 있는 “Sample12.html” 파일을 브라우저로 확인해 보자.
이 태그는 작성한 설명문이 그대로 표시 될 뿐이다.