phpDocumentor
v3.5.3
phpDocumentor 是 PHP 專案事實上的文件工具，為輕鬆產生全面的文件提供了強大的解決方案。透過分析您的 PHP 原始程式碼和 DocBlock 註釋，phpDocumentor 產生一套完整的 API 文檔，使其成為追求清晰且記錄良好的程式碼庫的開發人員不可或缺的工具。
除了 API 文件的實力之外，phpDocumentor 還提供了額外的功能。它具有創建 UML 圖的能力，使其成為可視化程式碼結構的多功能工具。此外，phpDocumentor 還提供功能齊全的標記語言解析器，支援 RestructedText 和 Markdown 語法。這種靈活性使您可以使用最適合您偏好的標記語言來記錄您的專案。
phpDocumentor 的一個顯著功能是它能夠將部分 API 文件直接包含到 RestructedText 文件中。這種整合可確保您的文件和程式碼保持同步，從而節省您維護準確和最新的專案文件的時間和精力。
受到其前身 phpDocumentor 1 和 JavaDoc 的啟發，phpDocumentor 不斷創新，緊跟著最新技術和 PHP 語言功能。這項承諾確保開發人員能夠獲得盡可能最佳的文件體驗，並與現代開發實踐保持一致。
在本指南中，我們將探討 phpDocumentor 的各種功能，從產生 API 文件的核心功能到解析標記語言的高階功能。無論您是初學者還是經驗豐富的開發人員，phpDocumentor 都是您創建文檔齊全、可維護且易於理解的 PHP 專案的盟友。
v3 是最新的穩定版本。
有關更多詳細信息，您可以查看我們的線上文件：https://docs.phpdoc.org/。
phpDocumentor 支援以下內容：
相容於 PHP 7.0+ ，提供對命名空間、閉包等的全面支援。
Docblock 優於 types ，docblocks 可以更明確地說明類型，但並非所有格式都受本機 php 支援。
顯示任何標籤，某些標籤為 phpDocumentor 添加附加功能（例如@link）。
記憶體佔用低，小型專案記憶體佔用峰值小於20MB，中型專案40MB，大型框架100MB。
增量解析，如果保留上次運行的結構文件，除了上面提到的處理速度提升之外，您還可以獲得高達 80% 的額外效能提升。
簡單的模板構建，如果您想製作品牌，您只需調用 1 個任務並編輯 3 個文件。
兩步驟過程，phpDocumentor 首先使用您的應用程式結構產生緩存，然後再建立輸出。如果您願意，您可以使用它來驅動您自己的工具或格式化程式！
泛型支持，隨著更多的靜態分析，php 類型變得更加複雜。 phpDocumentor 理解這些類型。並將它們呈現為一流類型。
PhpDocumentor 需要 PHP 8.1 或更高版本才能運作。但是，可以分析早期 PHP 版本的程式碼。
phpDocumentor 提供的所有範本都支援基於讀取程式碼庫的類別圖。這需要在執行 phpDocumentor 的電腦上安裝應用程式 [PlantUml]。使用 [PlantUml] 呈現類別圖是可選的，並且可以忽略缺少 [PlantUml] 的警告。但是，在這種情況下，您的文件將包含一些死連結。將使用選項--setting=graphs.enabled=true建立類別圖。
有4種方式安裝phpDocumentor：
使用 phive（推薦）
使用 PHAR（手動安裝）
通過碼頭工人
透過作曲家
$ phive install phpDocumentor --trust-gpg-keys 8AC0BAA79732DD42
有關 phive 的更多信息，請訪問他們的網站。現在你已經安裝了 phpDocumentor，它可以像這樣執行：
php tools/phpDocumentor
從 https://github.com/phpDocumentor/phpDocumentor/releases 下載 phar 文件
您可以像這樣執行 phar： php phpDocumentor.phar
$ docker pull phpdoc/phpdoc
$ docker run --rm -v $(pwd):/data phpdoc/phpdoc
但是等等？作曲家呢？
啊，你發現了我們的秘密。有一個 phpdocumentor 作曲家包，您可以使用它來安裝 phpDocumentor。
然而：phpDocumentor 是一個複雜的應用程序，它的庫被用於無數其他庫和應用程式（我們的兩個庫每個都有超過 1.5 億次下載）；這意味著我們的依賴項之一與您的依賴項之間發生衝突的可能性很高。當我說高時，它真的很高。
因此，由於上述原因：我們不認可也不積極支持使用 Composer 安裝 phpDocumentor。
運行 phpDocumentor 最簡單的方法是執行以下命令：
$ phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>
此命令將解析使用-d參數提供的原始程式碼並將其輸出到-t參數指示的資料夾。
phpDocumentor 支援一系列選項來配置文件的輸出。您可以執行以下命令，或查看我們的網站，以取得可用命令列選項的更詳細清單。
$ phpdoc run -h
phpDocumentor 也支援使用設定檔（預設名稱為 phpdoc.xml 或 phpdoc.dist.xml）。請查閱文件以查看格式和支援的選項。
PhpDocumentor 沒有夜間版本。然而，在每個管道期間都會建造一個 phar 工件。如果您想測試 phpDocumentor 的前緣版本，請查看此儲存庫的操作部分。每個成功的 QA 工作流程底部都有一個工件部分，其中建構了 phar 工件。
聯絡我們很容易，可以透過以下方式完成：
推特：@phpDocumentor
網址：https://www.phpdoc.org
GitHub：https://www.github.com/phpDocumentor/phpDocumentor
電子郵件：[email protected]
