PHPXref 是一款優秀的 PHP 開發輔助工具,能將項目中所有函數、變量、常量、類等進行分類索引,生成 HTML 文檔網站,極大地方便代碼閱讀、學習與維護。
核心功能
- 文件管理:快速搜索文件,自動提取註釋顯示文件用途
- 函數/變量/常量/類索引:查看定義位置、引用位置、調用關係
- 文件包含關係圖:展示 include/require 依賴鏈,避免重複包含
- 源代碼高亮顯示:瀏覽代碼更直觀
- 智能關聯導航:鼠標懸停顯示函數定義、變量使用統計
官方演示
官方提供 WordPress 分析文檔:https://phpxref.com/xref/wordpress/
Windows 環境安裝步驟
- 從 SourceForge 下載最新版(如 0.7 版 win32 打包)
- 解壓後,將目標項目源碼(如 WordPress)放入
phpxref/source/ 目錄下(注意:放源碼文件,不要放整個項目根目錄)
- 運行
phpxref.exe 開始生成文檔(約 1 分鐘,高 CPU/磁盤占用)
- 生成完成後,
output/ 目錄包含所有 HTML 文檔
- 部署到本地 Web 服務器(如 XAMPP htdocs),重命名為
phpxref,訪問 https://localhost/phpxref/
實戰價值
- 學習開源項目:快速掌握 WordPress、Discuz 等項目結構
- 項目代碼審計:發現重複代碼、未使用函數、潛在 Bug
- 團隊協作:新成員快速熟悉代碼庫
- 個人代碼庫整理:提取通用函數構建組件庫
注意事項
- 生成文檔體積龐大(WordPress 1.2MB 源碼生成 80MB+ 文檔),不建議直接部署到公網
- Linux 版本同樣可用,生成後可拷貝到 Windows 服務器運行
- 需 PHP 環境支持(解析 PHP 語法)
PHPXref 不僅是閱讀工具,更是重構與學習的利器。善用它,讓代碼結構一目了然。