Javadoc 만들기 | Javadoc 태그 | {@code} 태그
{@code}
태그는 Javadoc에 예제 코드 작성시 사용된다.
{@code source-code}
예제 코드 표시
작성 위치 : 개요, 패키지, 클래스, 인터페이스, 필드, 메소드
중복 작성 : 가능
설명에 예제 코드를 첨부할 영에 사용한다. 사용 방법 다음과 같다.
/**
* 주석의 설명문
*
* <pre>
* {@code
* Foo foo = new Foo();
* foo.foo();
* }
* </pre>
*/
설명문에 예제 코드를 첨부할 경우 {@code}
태그만 사용해도 되지만, 줄바꿈이 필요할 시에는 HTML <pre>
태그를 같이 사용해야 한다.
실습
간단한 예를 실습해 보도록 하겠다.
/**
* Javadoc 테스트용 클래스<br>
*
* <pre>
* {@code
* Foo foo = new Foo();
* foo.foo();
* }
* </pre>
*/
public class Sample15 {
}
위에 소스 코드를 “Sample15.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.
$ javadoc -d doc Sample15.java
생성된 “doc” 디렉토리에 있는 “Sample15.html” 파일을 브라우저로 확인해 보자.
위와 같이 코드 글꼴로 표시되고 있다. 코드 글꼴는 HTML <code>...</code>
태그로 묶여 적용되는 글꼴이다.