JavaDoc 生成文档

JAVADOC 命令是用来生成自己的API文档的。

参数信息：

• @author　　作者名
• @version　　版本号
• @since　　指明需要最早使用的JDK版本
• @param　　参数
• @return　　返回值情况
• @throws　　异常抛出情况

 

 

例：1.打开IDEA，建一个Doc.java的类，敲入以下代码

package com.yin.test;

/**
 * @author  yinsong
 * @version  1.0
 * @since 1.8
 *
 */

public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{

        return name;
    }

}

　在文件名上右击选择Show in Explorer ,地址栏前面加CMD ,进入命令行输入：　　　

　javadoc -encoding UTF-8 -charset UTF-8 Doc.java

　　在文件下生成index.htm的文件。点击打开