基於PHP的手動應用程序

Question

是否有用於編寫tehcnical/API類型手冊的精心製作的Web應用程序？我有一些代碼，我想寫一些「入門」指南，也許還有一些參考內容。

PHPDocumentor對於記錄我的類的層次結構來說都很好，但我也希望把這些東西放在一起，這樣可以讓人看起來更具有可讀性和線性。我想一般的CMS可以正常工作，或者只是從頭開始構建。但是，如果有任何設計專門用於編寫在線手冊，我想知道更多。

Answer 1

DocBook將是寫手冊的方法之一，但我不知道任何CMS。我已經分享了它在PEAR上的工作，到目前爲止，我一直使用普通的文本編輯器編寫/編輯頁面。我想，從頭開始是更難。

如果您需要某些東西更多直觀，請嘗試dokuwiki。它非常小巧輕便，而且很有效。

另外，請記住，phpdoc允許您嵌入代碼示例等，因此也許可以查看該示例（例如：inline {@example}）。

Answer 2

大多數他們的文檔寫入類似維基的服務。谷歌代碼有一個，或者你可以自己安裝，比如MediaWiki或Trac。

Answer 3

我不知道它是否會爲你做這項工作，但通過www.php.net在線提供的整個PHP手冊是一個開源應用程序。

不知道它的內部，但從用戶POV看起來足夠好。

Answer 4

我發現這些鏈接前一陣子....

http://www.winnershtriangle.com/w/Products.PHPDocumentationTool.asp

http://doc.php.net/php/dochowto/

享受...

Answer 5

restructured text是在Python社區的熱門選擇。