易百教程

15、什么是 API 文档?

任何基础都必须有一个好的文档。API 文档可作为访问库或在程序中工作的快速参考。
当我们使用任何此类文件时,它必须包括适当的计划、内容来源、适当的布局、与每个功能相关的信息等。
有各种文档工具,例如 Doxygen 和 JavaDoc。在这里,记录的函数围绕以下参数展开:

  • 功能说明
  • 可能出现的错误信息的类型和语法
  • 每个参数所需的语法、元素和顺序
  • 有关功能的链接