独立于平台的工具,用于创建API文档/建议[关闭](Platform Independent Too

2019-10-23 17:30发布

开发平台上独立API文档存在哪些工具?

我在设计提出的API的过程中,要在结构化和易于修改的方式来写文档。 很多我见过的答案已经基本“建于特定语言文档工具使用”,但因为我是从“顶层”设计的API,而不是实现它,这不是那么有用。 我在寻找一个CMS的API文档

我已经看到了一些建议使用PBWiki或合流,但我不相信,一个普通的维基是最好的选择,虽然版本控制方面很不错。

从理论上讲,一个Drupal建立与CCK的API调用,用于读取API意见,但是这是一个有点繁重的什么我要找的。

是否有一个API文档管理系统了吗? 什么是写作和原料药的管理独立于平台的文档的最佳选择?

我已经看到了相关的问题,这一点,但还没有得到满意的答案。

Answer 1:

任何结构化文本语言就行了。 我会使用乳液,和troff是老同学。

但是你可能已经错过了建议的点使用的doxygen或什么的。 如果你这样做,然后写文档放下了最终实施的支架。 更妙的是,该示例文件将在相同的格式作为最终实际文档和,你会-就可以了,你就不能课程---使用源控制的? 所以你必须更改规格的盆栽历史。



文章来源: Platform Independent Tool for Creating API Documentation / Proposal [closed]