Comments Densityダウンロード - Comments Densityソースコードのダウンロード

Comments Density

その他のカテゴリー

v0.3.0

ダウンロード

コメント密度アナライザー

PHPソースコードファイルのコメント密度と品質を分析するツールで、コードドキュメントの品質を維持および改善するのに役立ちます。

特徴

複数のコメントタイプ：通常、docblocks、todos、fixmes、ライセンス情報など、いくつかのコメントタイプの識別と分析をサポートしています。
ドキュメンテーションの欠落の検出：欠落しているdocblocks、 @throwsタグ、およびタイプの安全性とコードドキュメントを改善するジェネリックを識別します。
詳細なレポート：変更が必要になる可能性のあるコードスポットをすばやく見つけます。
品質チェック：構成ファイルを設定し、しきい値が満たされていない場合、レポートには出口コードが返されます。
設定可能なレポート：コンソールまたはHTMLファイルのいずれかで結果を取得します。
事前コミットフック：コミットされようとしているファイルのみを検証します。
ベースライン：古い技術的負債を無視し、新しい問題に焦点を当てるために、ベースラインに対してフィルターを収集したコメントを収集しました。

出力の例

インストール

コメント密度アナライザーをインストールするには、端末で次のコマンドを実行します。

composer require --dev savinmikhail/comments-density

使用法

PHPファイルのコメント密度を次のように分析します。

php vendor/bin/comments_density analyze:comments

でベースラインを生成します：

php vendor/bin/comments_density generate:baseline

構成

インストール時に、プラグインが構成ファイルを作成できるようにすることができます。 comments_dences.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
];