DAY15

JavaDoc生成文档

JDK帮助文档官方链接

@author 作者名

@version 版本

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

@param 参数名

@return 返回值

@throws 异常抛出情况

---

/**

• @author kuangshen
• @version 1.0
• @since 1.8
  */
  加在类上面就是类的注释

---

public class doc {
String name;
/**
* @author kuangshen
* @param name
* @return
* @throws Exception 出现异常
*/
public String Test(String name) throws Exception{
return name;
}
加在方法上面，就是方法的注释

运行：

cmd运行，输入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java，

此处需注意中间的空格，已出现过错误。

---

生成index文件

点击index文件，进入网页模式。