惠州javadoc如何输出？_北大青鸟IT学校

很多学习java语言的同学在学习的过程中，会有很多疑惑，javadoc如何输出就是其中一个。那么，接下来我们跟着惠州北大青鸟老师一起来学习一下javadoc如何输出。

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

 $

惠州高端IT学校的知名品牌，要学习，好工作，请来到北大青鸟校区。

Java

标签：惠州计算机JAVA软件开发惠州计算机Java软件开发惠州计算机JAVA培训惠州计算机JAVA软件开发学校惠州计算机Java软件开发培训JAVAJava软件开发北大青鸟IT计算机学校北大青鸟IT软件学校北大青鸟IT学校