JavaDoc

JavaDoc

JavaDoc命令是用来生成自己API的帮助文档的

 

文档注释

package com.rsp2012.base;
​
public class Demo8 {
    public static void main(String[] args) {
        int num1 = 10;
        double num2 = 3.14;
​
        Demo8 test = new Demo8();
        //实例化类
        System.out.println(test.sum(num1, num2));
        //调用方法计算num1与num2的和
    }
​
    /**
     * @param a 值a
     * @param b 值b
     * @return 值a和值b的和
     * @author rsp2012
     * @version 1.0
     * @since 1.8
     */
    public double sum(double a, double b) {
        double c = a + b;
        return c;
    }
}

 

• 参数

  • @author

    作者名

  • @version

    版本号

  • @since

    指明需要最早使用的JDK版本

  • @param

    参数名

  • @return

    返回值情况

  • @throws

    异常抛出情况

 

生成文档

命令行方式

cmd进入源文件目录下，使用javadoc命令生成。

命令：javadoc -encoding UTF8 -charset UTF8 Demo8.java

 

---

IDEA方式