반응형

@param 태그

@param태그는 매개 변수에 대한 설명을 표시 할 때 사용한다.

@param parameter-name description

매개 변수에 대한 설명을 표시한다.

작성 위치 : 메소드
중복 작성 : 가능
츌력 형식 : 매개 변수명 및 설명

@author 태그가 중복으로 작성된 경우는 출력 될 때 각각의 저자가 쉼표(,)로 구분하여 한 줄에 모와서 출력된다.

메소드의 매개 변수명과 매개 변수에 대한 설명을 작성한다. 사용 방법는 다음과 같다.

/**
 * 주석의 설명문
 * @param width 폭
 * @param height 높이
 */

설명 부분은 여러 줄에 걸쳐 작성 할 수 있다. 여러 줄에 걸쳐있는 것을 표현하는 방법은 특별한 작성법이 있는 것은 아니다.

/**
 * 댓글의 설명
 * @param width 폭
 * width 대한 설명 2번째 줄
 * width 대한 설명 3번째 줄
 * @param height 높이
 */

실습

간단한 예를 실습해 보도록 하겠다.

/**
 * Javadoc 테스트용 클래스
 */
public class Sample11 {

    /**
     * 사이즈 설정
     *
     * @param width 폭<br>
     * 단위는 센티미터
     * @param height 높이
     */
    public void setSize(int width, int height) {

    }
}

위에 소스 코드를 "Sample11.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.

$ javadoc -d doc Sample11.java

생성된 "doc" 디렉토리에 있는 "Sample11.html" 파일을 브라우저로 확인해 보자.

여러 줄로 설명을 작성한 경우도 HTML 문서로 취급되는 것에 주의하자. 줄 바꿈 할 경우 <br> 등의 줄 바꿈에 대한 태그가 필요하다.

반응형

'Javadoc' 카테고리의 다른 글

[Javadoc] @throws, @exception 태그  (0) 2019.10.20
[Javadoc] @return 태그  (0) 2019.10.20
[Javadoc] @param 태그  (0) 2019.10.20
[Javadoc] @since 태그  (0) 2019.10.20
[Javadoc] @deprecated 태그  (0) 2019.10.20
[Javadoc] @see 태그  (0) 2019.10.20

+ Recent posts