Comments Density - Comments Density do download do código -fonte

Comments Density

Outras categorias

v0.3.0

Baixar

Analisador de densidade de comentários

Uma ferramenta para analisar a densidade e a qualidade dos comentários nos arquivos de código -fonte do PHP, ajudando a manter e melhorar a qualidade da documentação do código.

Características

Vários tipos de comentários : suporta identificação e análise de vários tipos de comentários, incluindo documentos regulares, Todos, fixmes e informações de licença.
Detecção de documentação ausente : identifica a falta de docblocks, tags @throws e genéricos que melhoram a segurança do tipo e a documentação do código.
Relatórios detalhados : encontre rapidamente pontos de código onde as alterações possam ser necessárias.
Verificação de qualidade : Configure um arquivo de configuração e, se os limites não forem atendidos, o código de saída será retornado com o relatório.
Relatórios configuráveis : obtenha resultados no arquivo console ou html.
Gancho pré-comprometido : valide apenas os arquivos que estão prestes a ser comprometidos.
Linha de base : O filtro coletou comentários contra uma linha de base para ignorar a dívida técnica antiga e se concentrar em novas questões.

Exemplo de saída

Instalação

Para instalar o analisador de densidade de comentários, execute o seguinte comando em seu terminal:

composer require --dev savinmikhail/comments-density

Uso

Analise a densidade de comentários em seus arquivos PHP com:

php vendor/bin/comments_density analyze:comments

Gerar linha de base com:

php vendor/bin/comments_density generate:baseline

Configuração

Na instalação, você pode permitir que o plug -in crie seu arquivo de configuração. Personalize sua análise editando um arquivo de configuração Comemention_Dension.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
];