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

Posted haha

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Java如何制作帮助文档(API)相关的知识,希望对你有一定的参考价值。

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

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

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


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

以上是关于Java如何制作帮助文档(API)的主要内容,如果未能解决你的问题,请参考以下文章

java如何使用帮助文档api

给自己的java程序生成API帮助文档

继承和重写

Java API的帮助文档一般存在哪里?

java 帮助文档的制作javadoc

Java之API的使用