文档内容

文档内容是 API 文档的主要部分,文档内容的丰富内容和完整功能能让开发者迅速的找到自己想要的帮助。因此搭建一套结构清晰、功能完整的文档内容是十分的重要。

  • 接口细节 - API 文档内容最多的一部分,API 接口的工作量和维护成本也相对于其他事比较高得,因此自动化和规范是十分得重要。
  • 接口描述 - 简易的描述接口得基本信息,告知用户如何使用 API 接口。
  • 额外信息 - 一些接口除了接口描述,还需要一些额外的信息,例如一些警告、使用限制等等提示。
  • 成员类型 - 常见的成员参数类型、参数说明,返回值类型、返回值说明,同步或异步说明。
  • 异常错误 - 接口异常错误码的返回以及错误说明,确保核心程序不会崩溃。
QT Docs
QT Docs

示例代码

API 文档的使用和调取方式都是需要通过示例代码来展示的,而且当开发者想快速使用该功能模块时,能方便快速的复制示例代码来接入功能模块。 tensorflow-demos

代码复制

代码复制功能能让开发者快速的集成该功能模块,提升开发的效率。

在线演示

通过演示,让开发者直观的了解接口的差异和功能。 angular-material-demo

编辑调试

可以快速的让开发者模拟实际的场景,在使用前能预先了解结果,提高开发效率。 codepen-by-misha-tsankashvili

文档反馈

当文档上线后应该能及时的获取用户的意见和反馈,方便及时更进解决问题和优化 API 文档。

results matching ""

    No results matching ""