用于创建 API 文档/提案的平台无关工具 [关闭]

Posted 2023-02-19

【中文标题】用于创建 API 文档/提案的平台无关工具 [关闭]

【英文标题】：Platform Independent Tool for Creating API Documentation / Proposal [closed]

【发布时间】：2011-03-08 23:13:46

【问题描述】：

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

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

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

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

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

我已经看到了related questions，但还没有一个令人满意的答案。

【参考方案1】：

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

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