如何爲PHP項目創建自動代碼文檔？

Question

我有一個使用CakePHP的大項目。現在我想爲其他新同事創建一個文檔。

一個想法是使用代碼中現有的PHPdoc註釋和其他註釋爲一開始創建一個自動文檔。

1. 我該如何管理這樣一個大項目，以及如何創建可瀏覽的HTML文檔？

2. 我該如何自動添加缺少評論？
   （我使用Eclipse進行編碼，但如果它在另一個編輯器很容易，我不會介意）
   有聲明如下諸多功能：

   # some explanation not in phpDoc
function whatever() {
....
}

如果我可以使用外部編輯器僅編輯phpdoc註釋並且它們被自動插入在源代碼中正確的位置。

Answer 1

我不知道這會滿足您的要求多少。

但NetBeans IDE將幫助您處理文檔。

對於文檔指南，你可以參考以下網站：

Here is a guide for documentation

請建議，如果你能找到更好的。

Answer 2

您可以使用ApiGenerator插件。它是一個Cake插件，它使用與PhpDocumentor相同的語法，並且爲了生成文檔，您只需運行一個shell命令。

https://github.com/cakephp/api_generator