告別手寫 API文檔產生工具推薦

http://www.csdn.net/article/2013-02-20/2814189-API_DOC_TOOLS

隨著API的發展以及需求的日益增加，對API文字文件的需求與隨之而來。相信許多開發人員都遇到過編寫API文檔方面的問題及煩惱。

你是否還通過手寫的方式來產生和編寫這些文檔呢？那麼你就OUT啦！話說工欲善其事必先利其器，本文分享8款非常好的API文檔產生工具給大家。

Web API文檔工具列表

Swagger ——Swagger架構可以通過代碼產生漂亮的線上API，甚至可以提供運行樣本。支援Scala、Java、Javascript、Ruby、PHP甚至
Actionscript 3。線上 Demo 。

I/O Docs ——I/O Docs是一個用於RESTful Web APIs的互動式文檔系統。使用 JSON 模型根據資源、方法和參數定義
APIs。I/O Docs 將產生 JavaScript 用戶端介面，可通過這些介面來調用系統。伺服器端基於 Node.js 開發。線上Demo

apiary.io ——能夠快速啟動和運行文檔，包括GitHub整合和I/O驗證——更多建議可以前往Reddit查看上關於 Siyfion討論。

Docco ——Docco是一個快速而隨意、hundred-line-long、迭代程式風格的文檔產生器。它會以HTML的方式顯示評論和代碼。

Dexy ——非常靈活的一款文檔工具，支援任何語言編寫的API。

Doxygen ——Doxgen可以從一套歸檔源檔案開始，產生HTML格式的線上類瀏覽器，或離線的LATEX、RTF參考手冊。對於未歸檔的源檔案，也可以通過配置Doxygen來提取代碼結構。 更多建議可以前往Reddi上查看 gkumar007相關討論。

TurnAPI ——是一款付費的文檔API工具。裡麵包含了智能WIKI編輯器、基於標準的Markdown、文檔分支、還可以與Git、SVN、Mercurial同步、整潔的主題、友好的介面。

以上僅是作者在實踐中發現的一些很好的工具，如果你有更好的建議或工具推薦，歡迎與我們分享。