Comments Density - Comments Density

Comments Density

Kategori lainnya

v0.3.0

Unduh

Komentar Penganalisa Kepadatan

Alat untuk menganalisis kepadatan komentar dan kualitas dalam file kode sumber PHP, membantu mempertahankan dan meningkatkan kualitas dokumentasi kode.

Fitur

Jenis komentar berganda : Mendukung identifikasi dan analisis beberapa jenis komentar termasuk reguler, docblocks, todos, fixmes, dan informasi lisensi.
Deteksi dokumentasi yang hilang : Mengidentifikasi docblocks yang hilang, tag @Throws, dan obat generik yang meningkatkan jenis keamanan dan dokumentasi kode.
Pelaporan terperinci : Cepat temukan spot kode di mana perubahan mungkin diperlukan.
Pemeriksaan Kualitas : Mengatur file konfigurasi, dan jika ambang batas tidak terpenuhi, kode keluar akan dikembalikan dengan laporan.
Laporan yang dapat dikonfigurasi : Dapatkan hasil di konsol atau file HTML.
Pra-berkomitmen Hook : Validasi hanya file yang akan dilakukan.
Baseline : Filter yang dikumpulkan komentar terhadap garis dasar untuk mengabaikan utang teknis lama dan fokus pada masalah baru.

Contoh output

Instalasi

Untuk menginstal komentar penganalisa kepadatan, jalankan perintah berikut di terminal Anda:

composer require --dev savinmikhail/comments-density

Penggunaan

Menganalisis kepadatan komentar dalam file PHP Anda dengan:

php vendor/bin/comments_density analyze:comments

Menghasilkan garis dasar dengan:

php vendor/bin/comments_density generate:baseline

Konfigurasi

Pada instalasi, Anda dapat mengizinkan plugin untuk membuat file konfigurasinya. Kustomisasi analisis Anda dengan mengedit file konfigurasi komentar_density.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
];