JAVA基础学习（JavaDoc生成文档）

JavaDoc

Javadoc命令是用来生产自己的API文档的。

文档注释的写法是/*开头/结尾，一般在使用IDEA等集成开发环境时会自动补全。

JavaDoc的参数信息：

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

步骤：
首先在java文件中写好文档注释：

package com.zx;

/**
 * @author ZX
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    public String name;

    /**
     * @author ZX
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception
    {
        return name;
    }
}

然后选择在文件夹中打开JAVA文件

在文件夹中进入命令行

使用javadoc命令生成java文档注释

成功生成文档