2012-05-23 125 views
2

我正在構建一個需要非常好的文檔的API。我可以手動編寫所有文檔,但我覺得這樣做會比所需要的更努力。 Google已經爲Google提供了某種網絡文檔框架或工具,但似乎找不到任何東西。需要一個文檔框架

有誰知道的工具或框架,讓我建立的一個很好的,專業的設置也可以放在我的API的網站作爲參考其使用網絡上的文檔嗎?如果很容易更新或修改現有的文檔頁面而不需要完成一整套工作,這也會很好。

編輯:文檔的具體語言本身並不重要。現在,我只需要一些很好的選項來研究。

+0

什麼編程語言PHPDoc的? – mzjn

+0

API是用PHP編寫的,但我對如何使用什麼語言編寫/構建文檔並不挑剔。 – paradox870

回答

2

一種通用的方法是用註釋記錄代碼,然後生成文檔那。對於PHP有例如http://www.phpdoc.org/

+0

嗯......我會研究這一點。不知道這是我尋找的東西的類型,但值得一些調查。謝謝。 – paradox870

+0

儘可能少的工作是最好的。額外的獎勵是您的IDE可能會拿起它的原因,所以它會在您使用API​​時顯示手冊。 – Nanne

+0

是的。看起來好像你真的寫了很好的評論,那麼Web文檔基本上就是爲你完成的。如果我決定採取這種做法,我會接受答案,但現在我正在尋找更多選擇。 – paradox870

0

根據您所選擇的語言,有許多工具可以生成從代碼文檔註釋文檔頁面(如C/C的doxygen ++,javadoc中的Java)

確保你不僅文檔類和方法,但也提供實例用法,以及班級應該做什麼以及它如何適合框架的不重要的解釋。