Comments Density下载 - Comments Density源代码下载

Comments Density

其他类别

v0.3.0

下载

评论密度分析仪

一种工具来分析PHP源代码文件中的注释密度和质量，从而帮助维护和改善代码文档质量。

特征

多种评论类型：支持识别和分析多种评论类型，包括常规，docBlocks，todos，fixmes和许可证信息。
缺少文档检测：确定缺少的放置框架，@throws标签以及改善类型安全性和代码文档的通用物。
详细报告：快速找到可能需要更改的代码点。
质量检查：设置配置文件，如果未达到阈值，则将在报告中返回退出代码。
可配置的报告：在控制台或HTML文件中获取结果。
预加入钩子：仅验证即将投入的文件。
基线：过滤器收集的评论针对忽略旧技术债务而关注新问题的基线。

输出示例

安装

要安装评论密度分析仪，请在终端中运行以下命令：

composer require --dev savinmikhail/comments-density

用法

通过以下方式分析您的PHP文件中的评论密度

php vendor/bin/comments_density analyze:comments

生成基线：

php vendor/bin/comments_density generate:baseline

配置

安装时，您可以允许插件创建其配置文件。通过编辑comment_dense.php配置文件来自定义分析：

 <?php

return [
    ' directories ' => [
        ' src ' , // Directories to be scanned for comments
    ],
    ' exclude ' => [
        ' src/DTO ' , // Directories to be ignored during scanning
    ],
    ' thresholds ' => [
        // Limit occurrences of each comment type
        ' docBlock ' => 90 , 
        ' regular ' => 5 ,
        ' todo ' => 5 ,
        ' fixme ' => 5 ,
        ' missingDocBlock ' => 10 ,
        // Additional metrics thresholds
        ' Com/LoC ' => 0.1 , // Comments per Lines of Code
        ' CDS ' => 0.1 , // Comment Density Score
    ],
    ' only ' => [
        ' missingDocblock ' , // Only this type will be analyzed; set to empty array for full statistics
    ],
    ' output ' => [
        ' type ' => ' console ' , // Supported values: 'console', 'html'
        ' file ' => ' output.html ' , // File path for HTML output (only used if type is 'html')
    ],
    ' missingDocblock ' => [
        ' class ' => true , // Check for missing docblocks in classes
        ' interface ' => true , // Check for missing docblocks in interfaces
        ' trait ' => true , // Check for missing docblocks in traits
        ' enum ' => true , // Check for missing docblocks in enums
        ' property ' => true , // Check for missing docblocks in properties
        ' constant ' => true , // Check for missing docblocks in constants
        ' function ' => true , // Check for missing docblocks in functions
        ' requireForAllMethods ' => true , // If false, only methods where @throws tag or generic can be applied will be checked
    ],
    ' use_baseline ' => true , // Filter collected comments against the baseline stored in comments_density.sqlite
];