자바 문서 댓글
자바는 방법의 3 종류 주석에. 처음 두는 //와 / * * /와 * /와 / ** 엔드로 시작하는 전설 주석라고 세 번째.
설명 코멘트는 프로그램에서 프로그램에 대한 정보를 포함 할 수 있습니다. 당신은 HTML 파일에 대한 정보와 출력을 생성하는 Javadoc 툴을 사용할 수 있습니다.
설명 코멘트, 당신은 당신의 프로그램에 대한 자세한 정보를 기록.
javadoc의 태그
Javadoc 툴은 다음과 같은 태그를 인식합니다
| 상표 | 기술 | 예 |
|---|---|---|
| @author | 작성자의 클래스를 식별 | @author 설명 |
| @deprecated | 클래스의 멤버 이름 또는 만료 | @deprecated 설명 |
| {@docroot} | 현재 문서 루트 디렉토리에 지정된 경로 | 디렉토리 경로 |
| 예외 : | 슬로우 클래스 예외를 표시 | 예외 : 예외 이름 설명 |
| {@inheritDoc} | 직접 부모 클래스는 코멘트를 상속 | 바로 surperclass에서 댓글을 상속합니다. |
| {@link} | 다른 주제에 대한 링크를 삽입 | {@link 이름 텍스트} |
| {@linkplain} | 다른 주제에 대한 링크를 삽입하지만 링크는 일반 텍스트 글꼴로 표시됩니다 | 다른 주제에 인라인 링크를 삽입합니다. |
| @param | 방법 매개 변수 설명 | @param 매개 변수 이름 설명 |
| @return | 반환 형식 설명 | @return 설명 |
| @see | 다른 주제에 대한 링크를 지정합니다 | @see 앵커 |
| @serial | 속성의 순서에 대한 설명 | @serial 설명 |
| @serialData | 의 writeObject ()와 writeExternal 메소드에 의해 작성된 설명 방법 () 데이터 | @serialData 설명 |
| @serialField | 구성 요소에 대한 설명 ObjectStreamField를 | @serialField 이름 유형 설명 |
| @since | 변화의 특정 마커를 도입하는 경우 | @since 출시 |
| @throws | 그리고 예외 : 같은 레이블입니다. | @throws 태그는 예외 : 태그와 동일한 의미를 갖는다. |
| {@value} | 상수의 표시 값은 상수 정적 속성이어야합니다. | 정적 필드해야 상수의 값을 표시합니다. |
| @version | 지정된 클래스의 버전 | @version 정보 |
문서 댓글
시작 후 / **, 첫 번째 라인 또는 라인 클래스, 변수와 메소드의 주요 설명입니다.
그 후, 하나 또는 @ 태그 정렬 것을 더 포함 할 수있다. @ 각 태그는 새로운 라인에, 또는 별표 (*)가 다음 행의 시작 부분에서 시작해야합니다.
라벨의 동일한 타입의 복수의 그룹에 배치한다. 세 @see 태그가있는 경우, 예를 들어, 그들은 하나 하나 함께 넣을 수있다.
다음은 클래스 코멘트의 예를 들어 설명입니다 :
/*** This class draws a bar chart. * @author Zara Ali * @version 1.2 */
무엇 javadoc의 출력
입력으로 자바 프로그램의 소스 코드 Javadoc 툴, 출력 프로그램 주석을 포함하는 일부 HTML 파일입니다.
각 정보 유형은 HTML 파일 만 할 것이다. javadoc의 출력은 또한 나무와 인덱스를 상속 할 수 있습니다.
다른 javadoc의 구현 작업이 다를 수 있습니다 인해, 당신은 자바 개발 시스템 및 기타 세부 사항의 버전을 확인 자바 독의 해당 버전을 선택해야합니다.
예
다음은 간단한 예의 사용을 설명하는 설명이다. 그 설명의 이전 프로젝트 각각의 주석을 참고.
javadoc의 처리 후, SquareNum 클래스 노트는 SquareNum.html에서 찾을 수 있습니다.
import java.io.*;
/**
* This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
/**
* This method returns the square of num.
* This is a multiline description. You can use
* as many lines as you like.
* @param num The value to be squared.
* @return num squared.
*/
public double square(double num) {
return num * num;
}
/**
* This method inputs a number from the user.
* @return The value input as a double.
* @exception IOException On input error.
* @see IOException
*/
public double getNumber() throws IOException {
InputStreamReader isr = new InputStreamReader(System.in);
BufferedReader inData = new BufferedReader(isr);
String str;
str = inData.readLine();
return (new Double(str)).doubleValue();
}
/**
* This method demonstrates square().
* @param args Unused.
* @return Nothing.
* @exception IOException On input error.
* @see IOException
*/
public static void main(String args[]) throws IOException
{
SquareNum ob = new SquareNum();
double val;
System.out.println("Enter value to be squared: ");
val = ob.getNumber();
val = ob.square(val);
System.out.println("Squared value is " + val);
}
}
다음과 같이 Javadoc 툴을 사용하여 SquareNum.java 파일을 처리합니다 :
$ javadoc SquareNum.java
Loading source file SquareNum.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_13
Building tree for all the packages and classes...
Generating SquareNum.html...
SquareNum.java:39: warning - @return tag cannot be used\
in method with void return type.
Generating package-frame.html...
Generating package-summary.html...
Generating package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning
$