1

有哪些工具可用于开发独立于平台的 API 文档？

我正在设计提议的 API，并希望以结构化且易于编辑的方式编写文档。我看到的很多答案基本上都是“使用内置语言特定的文档工具”，但由于我是从“顶级”设计 API，而不是实现它，所以这不是那么有用。我正在寻找 API 文档的 CMS

我已经看到了一些使用 PBWiki 或 Confluence 的建议，但我不相信普通的 wiki 是最好的选择，尽管版本控制方面很好。

从理论上讲，使用 CCK 构建用于 API 调用和用于读取 API 的视图的 Drupal 构建，但这对于我正在寻找的东西来说有点繁重。

是否有 API 文档管理系统？为 API 编写和管理与平台无关的文档的最佳选择是什么？

我已经看到了与此相关的问题，但还没有一个令人满意的答案。

4

1 回答 1

3

任何结构化文本语言都可以。我会使用乳胶，而 troff 是老派。

但是您可能错过了使用 doxygen 或其他什么的建议的要点。如果你这样做了，那么编写文档也是为最终实现搭建脚手架。更好的是，示例文档将与最终的真实文档采用相同的格式，并且您将——当然——对其使用源代码控制，不是吗？因此，您将拥有规范更改的完整历史。

于 2010-06-28T02:51:54.003 回答