Java学习Day5——JavaDoc生成文档

• javadoc命令是用来生成自己API文档的
• 参数信息
  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

https://docs.oracle.com/javase/8/docs/api/

public class Doc {
    String name;

    
    public String test(String name) throws Exception {
        return name;
    }
  //我是通过命令行生成的JavaDoc文档
  //格式：javadoc 参数 Java文件

打开文件位置，之后在文件位置打开cmd，运行如下图命令。

运行结果如下：

在目标文件文件夹下生产了如下文件：

生成的doc文件如图：

需要课后学习的：学会查找使用IDEA生产JavaDoc文档！