idea下使用JavaDoc生产帮助文档

随着互联网的发展，项目越来越复杂，在加上项目运行好几年了，对外提供的API接口太乱了。那么怎么办呢？

本文将介绍，在idea下使用JavaDoc生成帮助文档。

在生成文帮助文档之前，我们需要把注释规范化。

官网关于javadoc介绍：https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html

中文介绍可以看：https://blog.csdn.net/vbirdbest/article/details/80296136

在idea下使用：

idea的导航栏-->tools-->Generate JavaDoc... 如下图：

在弹出

1. 点击上述菜单项后，会出现生成 JavaDoc 的对话框，一般的选项都很直观，不必细说。但是要注意生成 JavaDoc 的源代码对象的选择，一般以模块（Module）为主，必要时可以单独选择必要的 Java 源代码文件，不推荐以 Project 为 JavaDoc 生成的源范围。

2. 里面有一个 Locale 可选填项，表示的是需要生成的 JavaDoc 以何种语言版本展示，根据 javadoc.exe 的帮助说明，这其实对应的就是 javadoc.exe 的 -locale 参数，如果不填，默认可能是英文或者是当前操作系统的语言，既