2/23JavaDoc生成文档（day01）

JavaDoc生成文档

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

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

java帮助文档

package com.baidu.www;
/**
 * @author java
 * @version 1.6
 * @since 1.6
 */
public class HelloWorld {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{
            return name ;
    }

}

使用cmd命令行打开javadoc：

• javadoc 类名.java

• javadoc -encoding UTF-8 -charset UTF-8 类名.java

使用javadoc后会出现一系列文件，我们打开index.html,就可以看到一系列信息

---

使用IDEA打开javadoc