PhpCodeArcheology

phpcodearcheology

PHPCodearchEology分析您的PHP項目，提供有關文件，類，方法和功能的詳細指標。全面的HTML報告為您提供了評估項目所需的深刻見解。

為什麼要phpcodearcheology？

PhpCodearcheology的創建是為了幫助開發人員通過提供詳細的指標和見解來深入了解其PHP代碼庫。無論您是維護舊系統還是從事新項目，該工具都旨在促進更好的代碼質量和可維護性。

先決條件

確保您的環境滿足以下要求：

• PHP版本8.2或更高版本
• 作曲家安裝了

安裝

通過在您的終端中運行以下命令來安裝使用作曲家的PhpCodearcheology：

 composer require --dev php-code-archeology/php-code-archeology

快速開始

要啟動phpcodearcheology，請在項目root中運行以下命令：

 ./vendor/bin/phpcodearcheology

開箱即用，phpcodearcheology掃描了您的src dir，並在TMP/報告中創建了報告。

要自定義掃描，例如包含或排除文件夾，定義自定義PHP文件擴展名或其他設置，請在項目root中創建php-codearch-config.yaml配置文件。請參閱此示例配置文件以獲取指南。

報告

PhpCodearcheology生成的典型報告包括：

• 文件：項目中的文件總數。
• 文件錯誤：文件中發現的錯誤計數。
• 功能數：功能總數。
• 班級計數：類總數。
• 摘要類：抽像類的計數。
• 接口計數：接口總數。
• 方法計數：方法總數，包括公共，私人和靜態方法。
• 公共方法：公共方法計數。
• 私人方法：私人方法計數。
• 靜態方法：靜態方法計數。
• 輸出語句：迴聲和printf調用計數。
• 代碼線（LOC） ：代碼的總行，包括註釋和空行。
• 代碼的邏輯行（LLOC） ：代碼的總行不包括註釋和空行。
• 評論行（CLOC） ：包含註釋的代碼行。
• HTML代碼線：包含HTML的代碼行。
• 循環複雜性（CC） ：衡量代碼複雜性的度量。
• 可維護性索引（MI） ：指示代碼可維護性的索引。
• LCOM ：類方法缺乏凝聚力。
• 不穩定性：基於班級的依賴性衡量班級的穩定性。
• 傳出耦合（CE） ：類取決於類的類。
• 傳入耦合（CA） ：取決於類的類數量。
• 難度：衡量代碼難以理解的多麼困難。
• 努力：估算理解代碼所需的努力。
• 詞彙：代碼中的獨特操作員和操作數的數量。
• 長度：代碼中運算符和操作數的總數。
• 音量：代碼的詞彙和長度的大小。
• 評論權重：代碼中註釋的重量。
• 距離主線的距離：衡量類別的抽象和穩定性。

這是HTML報告的示例屏幕截圖：

文件

我目前正在研究文檔。由於我主要將該工具用於自己的項目，並專注於其持續開發，因此可能需要一些時間來完成全面的文檔。

作者

Marcus Kober，@mrcskbr，github