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

简介: Java如何制作帮助文档(API) 步骤如下:   (1)写一个工具类   (2)对这个类加入文档注释   (3)用工具解析文档注释     javadoc工具   (4)格式     javadoc -d 目录 -author -version ArrayTool.java   制作帮助文档(API)出错问题解决:     找不到可以文档化的公共或受保护的类       这句话告诉我们对想要操作的类的权限不够。

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 黑泽明军
【转载文章务必保留出处和署名,谢谢!】
相关文章
|
19天前
|
SQL Java API
使用Java Stream API简化集合操作
使用Java Stream API简化集合操作
|
18天前
|
负载均衡 安全 Java
Java中的服务治理与API网关实现
Java中的服务治理与API网关实现
|
18天前
|
监控 安全 Java
在Java中集成第三方API调用的最佳实践
在Java中集成第三方API调用的最佳实践
|
19天前
|
Java API
如何利用Java Stream API简化集合操作?
如何利用Java Stream API简化集合操作?
|
22天前
|
开发框架 Java API
Java中的REST API开发详解
Java中的REST API开发详解
|
23天前
|
XML Java API
使用Java构建RESTful API的最佳实践
使用Java构建RESTful API的最佳实践
|
24天前
|
Java API
Java中的日期和时间API详解
Java中的日期和时间API详解
|
17天前
|
并行计算 Java 数据挖掘
Java面试题:解释Java中的Stream API及其操作
Java面试题:解释Java中的Stream API及其操作
23 0
|
19天前
|
Java API
如何利用Java Stream API简化集合操作?
如何利用Java Stream API简化集合操作?
|
23天前
|
Java API 数据处理