JDK 帮助文档地址
https://docs.oracle.com/javase/8/docs/api
JavaDoc
javadoc命令是用来生成自己API文档的
JavaDoc参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
加在类上面就是类的注释,加在方法上面就是方法的注释
/**
* @author hu
* @version 1.0
* @since 1.8
*/ //类注释
public class Doc {
String name;
/**
* @param name //param 参数
* @return
*/ //方法注释
public String test(String name){
return name;
}
}
打开所在文件夹
运用命令行生成JavaDoc文档!
先进入cmd窗口
输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java
打开 index.html 网页
进去点开Doc
重点:命令行命令格式:javadoc 参数 Java文件