如何通过cmd生成javaDoc（API)文档

JavaDOC是生成自己的API文档

相信你已经对java文档有一定的了解，那么我们该怎么自己生成自己的javadoc文档呢？

常用制作java文档的几个关键生明

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

这里可以跟着我写个实例

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

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

写好这个实例后，在文件夹中找到这个java文件的位置 然后双击路径框，在开头写上cmd+空格。然后回车键

第二部是写入生成doc文档的代码了

javadoc -encoding UTF-8 -charset UTF-8 Doc.java
UTF-8防止乱码

写好后回车键

然后就生成了一个简单的doc文档啦，再回去看看这个路径下的文件会多很多的东西

点击index.html，可以看看自己创的简单的doc文档页面