JAVA基础12-JavaDoc生成文档

JavaDoc

javadoc用来生成自己的API文档的

参数信息

@author作者名

@version 版本号

@since 指明需要最早使用的jdkban版本

@param 参数名

@return 返回值异常

@throws 异常抛出情况

package com.faq.base;

/**
 *@author faq
 *@version 1.0
 *@since 1.8
 */
public class Demo4 {
    String name;

    /**
     * @param name
     * @return
     * @throws Exception
     */
    //把下面写完敲/**回车自动生成
    public String test(String name) throws Exception{
        return name;
    }
}

生成javadoc

IDEA中如图点击进入文件夹找到demo4的文件位置

cmd

E:\JAVA\code\JAVASE\HELLO\src\com\faq\base>javadoc -encoding UTF-8 -charset UTF-8 Demo4.java

生成Javadoc(在文件夹中出现index.html)

思考在IDEA中如何直接生成Javadoc文档