javadoc 도구는 Java 프로그램의 소스 코드를 입력으로 사용하고 프로그램에 대한 설명이 포함된 일부 HTML 파일을 출력합니다.
각 수업에 대한 정보는 별도의 HTML 파일에 담을 예정입니다. Javadoc은 상속된 트리 구조와 인덱스도 출력할 수 있습니다.
javadoc의 구현이 다르기 때문에 작업 내용도 다를 수 있습니다. Java 개발 시스템의 버전과 기타 세부 사항을 확인하여 적절한 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 $
위 내용은 고급 Java 튜토리얼입니다. javadoc이 출력하는 내용에 대한 자세한 내용은 PHP 중국어 웹사이트(www.php.cn)를 참고하세요!