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
];