javadoc生成API文档

给类或类中的方法写多行注释

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

1. 资源管理器 cmd + 空格 + 路径，进入到文件所在的目录
2. 使用命令 javadoc -encoding UTF-8 -charset UTF-8 文件名.java，（使用UTF-8防止文档乱码）生成文档
3. 回到文件所在目录点击index.html看到文档

使用IDEA也能生成javadoc文档：手把手教你使用 idea 生成漂亮的 javadoc 文档

javadoc生成API文档

原文：https://www.cnblogs.com/dearjohn/p/14696092.html