Comments Density

주석 밀도 분석기

PHP 소스 코드 파일의 댓글 밀도 및 품질을 분석하여 코드 문서 품질을 유지하고 개선하는 데 도움이됩니다.

특징

• 다중 주석 유형 : 일반, 문서, 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

구성

설치시 플러그인이 구성 파일을 만들 수 있습니다. Comment_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
];

감사의 말

이 프로젝트는 Yegor Bugayenko에서 영감을 받았습니다. OpenSource 아이디어를 참조하십시오.

기여

기부금을 환영합니다! 풀 요청을 제출하십시오.

특허

이 라이브러리는 MIT 라이센스에 따라 릴리스됩니다.

---