如何生成Java文档注释(Java Doc Comments)

在我们的Java SDK中已经提供了javadoc工具来生成我们的文档。

所以我们可以手动调用javadoc工具来生成文档，或者通过IDE生成。当然IDE也是调用javadoc，不过更快更省事。

注释的书写方式：https://blog.csdn.net/weixin_43670802/article/details/105612176

javadoc的用法

注意点

我们生成文档主要需要处理的问题有这几个：

• 编码问题，毕竟要处理好中文乱码的糟心事。
• 文档总体语言显示问题，如果不设置地区的话，默认是英语显示的呦，注意不是我们自己写的文档注释，是文档页面总体语言。

手动生成

javadoc -locale zh_CN -charset utf-8 -encoding utf-8 DOCTest.java

-locale zh_CN 地区，决定文档整体页面的语言

-charset utf-8 字符集，解决乱码问题

-encoding utf-8 编码，解决乱码问题

DOCTest.java 目标文件

通过IDEA生成

通过Idea生成也是大同小异，处理好地区与编码就好了。