Java如何制作帮助文档(API)

最新推荐文章于 2021-12-14 11:11:35 发布

weixin_34037515

最新推荐文章于 2021-12-14 11:11:35 发布

阅读量584

点赞数 1

CC 4.0 BY-SA版权

文章标签： java

原文链接：https://yq.aliyun.com/articles/607733

本文介绍如何使用 Java 制作帮助文档(API)，包括编写工具类、添加文档注释及利用 javadoc 工具解析这些注释。此外还解决了找不到可文档化的公共或受保护的类的问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Java如何制作帮助文档(API)

步骤如下：
　　(1)写一个工具类
　　(2)对这个类加入文档注释
　　(3)用工具解析文档注释
　　　　javadoc工具
　　(4)格式
　　　　javadoc -d 目录 -author -version ArrayTool.java

　　制作帮助文档(API)出错问题解决：
　　　　找不到可以文档化的公共或受保护的类
　　　　　　这句话告诉我们对想要操作的类的权限不够。在类前面加上public即可。
如下图所示02：

---------------------------------------
　　将来做开发的时候，我们给别人的东西就是Xxx.class文件和帮助文档(API)。别人通过帮助文档(API)来使用Xxx.class文件。
　　这就是面向对象思想，我才不管你是怎们实现的呢！我满足你的条件会用就可以。

我的GitHub地址： https://github.com/heizemingjun
我的博客园地址： http://www.cnblogs.com/chenmingjun
我的蚂蚁笔记博客地址： http://blog.leanote.com/chenmingjun
Copyright ©2018 黑泽明军
【转载文章务必保留出处和署名，谢谢！】