슬기로운 개발자 생활

-version 옵션-version 옵션은 생성된 문서에 @version 태그로 지정된 버전을 출력하도록 지정한다. -version 옵션이 지정되지 않을 경우 @version 태그가 코멘트 중에 작성되어 있어도 생성되는 문서 버전은 출력되지 않는다.※ @version 태그에 대해서는 @version 태그 페이지를 참조하길 바란다.사용법은 다음과 같습니다.$ javadoc -version [대상 파일] 예를 들어 다음과 같이 실행합니다.$ javadoc -version Sample.java 실습간단한 예를 실습해 보도록 하겠다./** * Javadoc 테스트용 클래스 * * @version 1.0 */ public class Sample06_1 { /** * 사이즈 설정 * * @param width 폭 ..

-author 옵션-author 옵션은 생성된 문서에 @author 태그로 지정된 저자를 출력하도록 지정한다. "-author" 옵션이 지정되지 않을 경우 @author 태그가 주석에 작성이 되어 있어도 생성되는 문서에 저자는 출력되지 않는다.※ @author 태그에 대해서는 @author 태그 페이지를 참조하길 바란다.사용법은 다음과 같다.$ javadoc -author [대상 파일] 예를 들어 다음과 같이 실행합니다.$ javadoc -author Sample.java 실습간단한 예를 실습해 보도록 하겠다./** * Javadoc 테스트용 클래스 * * @author devkuma */ public class Sample05_1 { /** * 사이즈 설정 * * @param width 폭 * @par..

-d 옵션-d 옵션은 생성 된 문서의 대상 디렉토리를 지정한다. 디렉토리는 상대 경로 또는 절대 경로로 지정한다.사용법은 다음과 같다.$ javadoc -d {출력하는 디렉토리 혹은 대상 파일} 예를 들면 다음과 같이 실행한다.$ javadoc -d doc Sample.java $ javadoc -d sample/doc Sample.java $ javadoc -d /Users/devkuma/javadoc/doc Sample.java 1번째와 2번째는 상대 경로로 지정하였다. 1번째는 "javadoc"명령을 실행한 디렉토리에 "doc"디렉토리를 만들고 그 안에 저장한다. 2번째는 "sample\doc"이란 디렉토리를 만들고 그 안에 저장한다. 3번째는 절대 경로로 지정한다. "/Users/devkuma/j..

Javadoc 옵션 지정Javadoc 도구를 사용할 때에 몇 가지 옵션이 준비되어 있다. 여기에서는 각 옵션의 사용 방법에 대해 실제 예를 보면서 확인해 보겠다. -help 옵션-help 옵션은 온라인 도움말을 표시한다. javadoc 커멘드의 사용법과 옵션에 대한 설명이 표시된다.다음과 같이 실행하십시오.$ javadoc -help 실행 결과는 다음과 같이 표시된다.$ javadoc -help Usage: javadoc [options] [packagenames] [sourcefiles] [@files] -overview Read overview documentation from HTML file -public Show only public classes and members -protected Sho..

{@code} 태그는 Javadoc에 예제 코드 작성시 사용된다.{@code source-code} 예제 코드 표시 작성 위치 : 개요, 패키지, 클래스, 인터페이스, 필드, 메소드 중복 작성 : 가능 설명에 예제 코드를 첨부할 영에 사용한다. 사용 방법 다음과 같다./** * 주석의 설명문 * * * {@code * Foo foo = new Foo(); * foo.foo(); * } * */ 설명문에 예제 코드를 첨부할 경우 {@code} 태그만 사용해도 되지만, 줄바꿈이 필요할 시에는 HTML 태그를 같이 사용해야 한다.실습간단한 예를 실습해 보도록 하겠다./** * Javadoc 테스트용 클래스 * * * {@code * Foo foo = new Foo(); * foo.foo(); * } * */ ..

{@link} 태그는 다른 Javadoc 태그 중에 참조 링크를 표시 할 경우에 사용한다. 지금까지의 태그들은 모두 블록 태그라고 불리는 반면에 이 태그는 인라인 태그라고 한다. 인라인 태그는 {}로 묶어 사용하여 주석을 설명문 안이나 다른 블록 태그 안의 문자열의 부분에 사용할 수 있다.{@linkplain}태그는 {@link} 태그와 기본적인 사용법은 동일하다. 다른 Javadoc 태그에서 문자열을 표시 할 위치에 참조 링크를 표시 할 경우에 사용한다. 다른 점은 {@link} 태그를 사용하는 경우 연결 문자열은 코드 텍스트로 표시되는 반면, {@linkplain} 태그의 경우는 링크가 된 문자열을 일반 텍스트로 표시되는 점 뿐이다.{@link package.class#member label} 블록 ..

@throws, @exception 태그@throws 태그는 발생할 수 있는 예외에 대한 설명을 표시 할 때 사용한다. 그리고 @exception태그와 '@throws'태그는 태그 이름이 다를뿐 동일하게 사용한다.@throws class-name description 예외에 대한 설명을 표시 작성 위치 : 메소드 중복 작성 : 가능 출력 형식 : Throws 메소드 내에서 발생하는 예외에 대한 예외 클래스 이름과 설명을 입력한다. 사용 방법은 다음과 같다./ ** * 주석의 설명문 * * @throws java.io.FileNotFoundException 지정된 파일을 찾을 수 없습니다 * / 클래스 이름은 전체 패키지명 까지 모두 지정되지만 패키지 이름이 생략된 경우에는 다음의 순서에 따라 검색한다.현..

@return 태그@return 태그는 반환 값에 대한 설명(데이터 유형 및 범위 등)을 표시 할 때 사용한다.@return description 반환 값에 대한 설명을 표시 기술 위치 : 메소드 복수 작성 : 불가능 출력 형식 : 반환 값 메소드의 반환 값에 대한 설명을 작성한다. 사용 법은 다음과 같다./** * 주석의 설명문 * @return 계산한 면적 */ 실습간단한 예를 실습해 보도록 하겠다./** * Javadoc 테스트용 클래스 */ public class Sample12 { /** * 사이즈 설정 * * @param width 폭 * @param height 높이 * @return 계산한 면적 */ public int getSize(int width, int height) { return..