独立于平台的工具，用于创建API文档/建议 [英] Platform Independent Tool for Creating API Documentation / Proposal

问题描述

开发平台上独立API文档存在什么工具？

What tools exist for developing platform indepedent API Documentation?

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

I'm in the process of designing a proposed API, and want to write documentation in a structured and easily editable way. A lot of the answers I've seen have basically been "Use built in language specific documentation tools", but since I'm designing the API from a 'top-level', rather than implementing it, this isn't so useful. I'm looking for a CMS for API Documentation

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

I've seen a few suggestions to use PBWiki or Confluence, but I'm not convinced that a plain wiki is the best option, though the version control aspects are nice.

在理论上，一个Drupal建立与CCK的API调用和读取API意见，不过这是一个有点繁重的什么我要找的。

In theory, a Drupal build with CCK for API calls and Views for reading the API, but that's a bit of heavy lifting for what I'm looking for.

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

Is there a API Documentation Management System out there? What are the best options for writing and managing platform-independent documentation for APIs?

我见过的<一个href=\"http://stackoverflow.com/questions/1775503/minimalistic-tools-for-developer-documentation\">related问题，对于这一点，但还没有成为一个满意的答复。

I've seen the related questions for this, but there has yet to be a satisfactory answer.

推荐答案

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

Any structured text language will do. I'd use latex, and troff is old school.

但是，你可能已经错过了建议的点使用的doxygen或什么的。如果你这样做，然后写文档的也的铺设，为最终实现支架。更妙的是，该示例文件将在相同的格式作为最终的真正的文件，并且你会 - 当然 - 它使用源代码控制，会不会呀？所以你必须改变规范的盆栽历史。

But you may have missed the point of the suggestion to use doxygen or whatever. If you do that, then writing the documentation is also laying down the scaffold for the eventual implementation. Better still, the example documentation will be in the same format as the eventual real documentation and, you will--of course---use source control on it, won't you? So you'll have a potted history of changes to the spec.

这篇关于独立于平台的工具，用于创建API文档/建议的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！