Comments Density herunterladen - Comments Density Quellcode herunterladen

Comments Density

Andere Kategorien

v0.3.0

Herunterladen

Kommentare Dichteanalysator

Ein Tool zur Analyse der Kommentardichte und -qualität in PHP -Quellcode -Dateien, wodurch die Qualität der Codedokumentation gewartet und verbessert wird.

Merkmale

Mehrere Kommentartypen : Unterstützt die Identifizierung und Analyse mehrerer Kommentartypen, einschließlich regulärer Docblocks, Todos, FixMes und Lizenzinformationen.
Erkennung fehlender Dokumentation : Identifiziert fehlende Docblocks, @Throws -Tags und Generika, die die Sicherheit und die Code -Dokumentation der Typtyp verbessern.
Detaillierte Berichterstattung : Finden Sie schnell Codespots, an denen möglicherweise Änderungen erforderlich sind.
Qualitätsprüfung : Richten Sie eine Konfigurationsdatei ein, und wenn Schwellenwerte nicht erfüllt sind, wird der Exit -Code mit dem Bericht zurückgegeben.
Konfigurierbare Berichte : Ergebnisse in der Konsolen- oder HTML -Datei erhalten.
Pre-Commit-Haken : Validieren Sie nur die Dateien, die festgelegt werden sollen.
Grundlinie : Filter sammelte Kommentare gegen eine Basis, um alte technische Schulden zu ignorieren und sich auf neue Themen zu konzentrieren.

Ausgangsbeispiel

Installation

Führen Sie den folgenden Befehl in Ihrem Terminal aus, um den Kommentardichteanalysator zu installieren:

composer require --dev savinmikhail/comments-density

Verwendung

Analysieren Sie die Kommentardichte in Ihren PHP -Dateien mit:

php vendor/bin/comments_density analyze:comments

Basislinie erzeugen mit:

php vendor/bin/comments_density generate:baseline

Konfiguration

Bei der Installation können Sie Plugin erstellen, um seine Konfigurationsdatei zu erstellen. Passen Sie Ihre Analyse an, indem Sie eine Konfigurationsdatei comments_density.php bearbeiten:

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