PHP 程式設計/phpDocumentor
< PHP 程式設計
phpDocumentor 是一款使用內聯註釋自動生成易於閱讀的軟體文件的工具。
理想的文件有兩個特性。首先，它應該易於維護和更新。其次，它應該易於讀者閱讀和瀏覽。這些往往是相互矛盾的目標。透過使用類似於 javadoc 和 phpDocumentor 的工具，你可以同時實現這兩個目標。在編寫文件時，只需在程式碼中插入特殊的註釋。然後 phpDocumentor 將解析您的程式碼並生成易於使用的 HTML、DocBook 或 PDF 文件。
phpDocumentor 識別的註釋是 C 風格的註釋，在開始標籤中有兩個星號。
/** * */
這些被稱為 DocBlock 註釋。透過將它放在程式碼中的元素之前，phpDocumentor 將為該元素生成文件。例如，如果我想為 "RhesusMacaque" 類編寫文件，我會在它之前放置一個 DocBlock。
/**
* This documents the Rhesus Macaque
*/
class RhesusMacaque
{
...
phpDocumentor DocBlock 有三個部分。第一部分是程式碼元素的簡短摘要，不應超過一句話。接下來是幾句話，更詳細地描述元素，這是可選的。最後，是一系列的 標籤.
/**
* The Rhesus Macaques rule the world through a secret conspiracy
*
* The Rhesus Macaques have been quietly watching human civilization
* for centuries. They have quietly influenced events through a
* variety of mechanisms. See class members for more details.
*
*/
class RhesusMacaque
{
...
標籤可以插入 DocBlock 中，以更詳細地描述程式碼元素的某些部分。它們提供資料，例如函式的返回值型別或程式碼的作者。它們用 "@" 符號標記，形式如下：
* @tagname properties
每個元素型別都有不同的標籤集來描述它。參見 phpDocumentor 文件化的元素.
一個類似於
phpdoc --target /var/www/phpdoc --output "HTML:Smarty:php" --directory /var/www/app --filename **/*.php
的命令將從 /var/www/app 中找到的 PHP 檔案生成文件。
有關輸出格式的完整列表，請參見 PhpDocumentor 網站.
請注意，輸出引數的值區分大小寫。
- 由 --output 命令列選項指定的轉換器 HTMLsmartyConverter 不是一個類
- "smarty" 中的 "s" 應該是大寫。
- 模板目錄 "/var/www/pear/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/php/" 不存在
- "php" 應該是大寫。