Comments Density

التعليقات محلل كثافة

أداة لتحليل كثافة التعليق وجودة ملفات رمز المصدر PHP ، والمساعدة في الحفاظ على جودة وثائق الرمز وتحسينها.

سمات

• أنواع التعليقات المتعددة : يدعم تحديد وتحليل العديد من أنواع التعليقات بما في ذلك معلومات العادية ، والموظفات العادية ، و todos ، و fixmes ، ومعلومات الترخيص.
• اكتشاف الوثائق المفقودة : يحدد docblocks المفقودة ، علامات therws ، والكمال العام الذي يحسن توثيق السلامة والرمز.
• الإبلاغ التفصيلي : ابحث بسرعة إلى مواقع الرمز حيث قد تكون التغييرات ضرورية.
• فحص الجودة : قم بإعداد ملف تكوين ، وإذا لم يتم استيفاء العتبات ، فسيتم إرجاع رمز الخروج مع التقرير.
• التقارير القابلة للتكوين : احصل على نتائج إما ملف وحدة التحكم أو HTML.
• خطاف ما قبل الالتزام : تحقق فقط من الملفات التي على وشك الالتزام.
• خط الأساس : جمع التصفية التعليقات ضد خط الأساس لتجاهل الدين التقني القديم والتركيز على قضايا جديدة.

مثال الإخراج

تثبيت

لتثبيت محلل كثافة التعليق ، قم بتشغيل الأمر التالي في المحطة الخاصة بك:

composer require --dev savinmikhail/comments-density

الاستخدام

تحليل كثافة التعليق في ملفات PHP الخاصة بك مع:

php vendor/bin/comments_density analyze:comments

توليد خط الأساس مع:

php vendor/bin/comments_density generate:baseline

إعدادات

عند التثبيت ، يمكنك السماح للمكون الإضافي بإنشاء ملف التكوين الخاص به. قم بتخصيص تحليلك عن طريق تحرير ملف تكوين Comments_dense.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.

المساهمة

المساهمات مرحب بها! لا تتردد في تقديم طلب سحب.

رخصة

يتم إصدار هذه المكتبة تحت رخصة معهد ماساتشوستس للتكنولوجيا.

---