[Javadoc] {@link}, {@linkplain} 태그

{@link} 태그는 다른 Javadoc 태그 중에 참조 링크를 표시 할 경우에 사용한다. 지금까지의 태그들은 모두 블록 태그라고 불리는 반면에 이 태그는 인라인 태그라고 한다. 인라인 태그는 {}로 묶어 사용하여 주석을 설명문 안이나 다른 블록 태그 안의 문자열의 부분에 사용할 수 있다.

{@linkplain}태그는 {@link} 태그와 기본적인 사용법은 동일하다. 다른 Javadoc 태그에서 문자열을 표시 할 위치에 참조 링크를 표시 할 경우에 사용한다. 다른 점은 {@link} 태그를 사용하는 경우 연결 문자열은 코드 텍스트로 표시되는 반면, {@linkplain} 태그의 경우는 링크가 된 문자열을 일반 텍스트로 표시되는 점 뿐이다.

{@link package.class#member label}

블록 태그 안의 설명문이나 문자열 부분에서 참조 링크 표시

작성 위치 : 개요, 패키지, 클래스, 인터페이스, 필드, 메소드
중복 작성 : 가능

"package.class#member" 형식으로 지정하는 다른 메소드에 대한 링크를 만든다. 링크 레이블에 지정된 "label"이 표시되지만, "label"는 선택 사항이다. 생략한 경우는 대상 메소드명으로 표시된다. 기본적인 사용법은 @see 태그와 동일한다.

/ **
 * 주석의 설명문
 * 다음 메소드 {@link Sample14#setSize(int, int) setSize}를 참조
 * /

패키지명을 생략한 경우에 어떻게 링크를 검색하거나 대해서는 @see 태그 (참조 링크)를 참조하길 바란다.

실습

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

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

      /**
       * 이름 설정
       * 반환은 {@link Sample14#getName() getName}을 참조
       *
       * @param name 이름
       */
      public void setName(String name){

      }

      /**
       * 이름 반환
       * 설정은 {@link #setName(String)}을 참조
       *
       * @return 이름을 String으로 반환
       */
      public String getName(){
          return null;
      }

}

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

$ javadoc -d doc Sample14.java

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

먼저 {@link} 태그와 {@linkplain} 태그의 다른 확인해 보도록 하자. 위 문장은 {@link} 태그로 작성되어 코드 문자로 표시되고 있고, 아래 문장이 {@linkplain} 태그로 작성되어 기본 문자 글꼴 표시되고 있다.

코드 글꼴은 HTML <code>...</code> 태그로 묶인 경우에 적용되는 글꼴이고, 기본 문자 글꼴은 이 HTML 태그로 묶여 있지 않아서 표시 모양이 다르다. 링크로 표시되는 것은 동일하다.

위와 같이 {@link} 태그와 {@linkplain} 태그는 설명문에 인라인 링크를 만들 때 사용하고, 링크를 참조로 별도 기준으로 표시 할 경우에는 @see 태그를 사용한다.