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