手把手教你使用 idea 生成漂亮的 javadoc 文档

1、打开 idea,点击 Tools-> Generate JavaDoc,这样会打开生成 javadoc 文档的配置页面。

2、进行配置:

标注的是重要的部分,从上往下分别是配置 javadoc 的范围,输出文件夹路径以及命令行参数。

这里的命令行参数很重要,因为只有使用 utf-8 编码才能保证生成时可以正常处理中文字符,所以一定要加上:

-encoding utf-8 -charset utf-8

还可以配置那些注解需要生成,哪些权限类(private、package、protected、public)需要生成等等精细的控制。

还有一点需要注意,即不要勾选“Include test sources”,勾选后,生成时会造成很奇怪的错误。

3、配置好后,点击生成按钮,生成好后就会自动在浏览器打开进行查看咯,是不是很棒O(∩_∩)O~

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容