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 黑泽明军
【转载文章务必保留出处和署名,谢谢!】
相关文章
|
3天前
|
Java 程序员 API
Java并发基础:concurrent Flow API全面解析
java.util.concurrent.Flow定义了响应式编程的核心接口,促进了Java在异步数据处理和背压机制方面的标准化,这使得第三方库如Reactor和RxJava能够基于这些接口提供丰富的实现和功能,同时简化了响应式编程在Java中的使用,Flow API增强了Java在并发编程领域的灵活性,使得处理异步数据流变得更加自然和高效。
Java并发基础:concurrent Flow API全面解析
|
23天前
|
Java API
Java 8 时间和日期 API
Java 8 时间和日期 API
27 1
|
1月前
|
Java API
【Java】API详解
【Java】API详解
62 2
|
2月前
|
Java API
zk java api
zk java api
16 0
|
2月前
|
Java API
java 操作es api
java 操作es api
32 0
|
18天前
|
存储 Java 关系型数据库
Java8新特性:强大的Stream API
Java8新特性:强大的Stream API
22 0
|
21天前
|
存储 运维 安全
Java常用类和基础API
Java常用类和基础API
32 0
|
22天前
|
存储 安全 Java
JAVA8实战 - 日期API
JAVA8实战 - 日期API
70 0
|
24天前
|
Java 编译器 API
【Java】lambda表达式,Stream API,函数式编程接口
【Java】lambda表达式,Stream API,函数式编程接口
24 0
|
30天前
|
JSON Java API
Java 编程问题:十三、HTTP 客户端和 WebSocket API
Java 编程问题:十三、HTTP 客户端和 WebSocket API
57 0

相关产品

  • 云迁移中心