PhpCodeArcheology

phpcodearcheology

يقوم PhpCodearcheology بتحليل مشروع PHP الخاص بك ، حيث يوفر مقاييس مفصلة على الملفات والفئات والأساليب والوظائف. يزودك تقرير HTML الشامل برؤى عميقة ضرورية لتقييم مشروعك.

لماذا phpcodearcheology؟

تم إنشاء phpcodearcheology لمساعدة المطورين على فهم أعمق لقاعدة الكود PHP من خلال توفير مقاييس ورؤى مفصلة. سواء كنت تحافظ على نظام قديم أو تعمل على مشروع جديد ، تهدف هذه الأداة إلى تسهيل جودة الكود بشكل أفضل وقابلية الصيانة.

المتطلبات الأساسية

تأكد من أن بيئتك تلبي المتطلبات التالية:

• الإصدار PHP 8.2 أو أعلى
• ملحن مثبت

تثبيت

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

 composer require --dev php-code-archeology/php-code-archeology

بداية سريعة

لبدء phpcodearcheology ، قم بتشغيل الأمر التالي في جذر المشروع الخاص بك:

 ./vendor/bin/phpcodearcheology

خارج المربع ، يقوم PhpCodearcheology بمسح SRC DIR ويقوم بإنشاء التقرير في TMP/التقرير .

لتخصيص المسح ، مثل تضمين المجلدات أو استبعادها ، وتحديد ملحقات ملفات PHP المخصصة ، أو الإعدادات الأخرى ، قم بإنشاء ملف تكوين php-codearch-config.yaml في جذر المشروع الخاص بك. ارجع إلى ملف التكوين العينة هذا للتوجيه.

التقرير

يتضمن التقرير النموذجي الذي تم إنشاؤه بواسطة phpcodearcheology مقاييس مثل:

• الملفات : إجمالي عدد الملفات في المشروع.
• أخطاء الملف : عدد الأخطاء الموجودة في الملفات.
• عدد الوظائف : إجمالي عدد الوظائف.
• عدد الفئة : إجمالي عدد الفئات.
• الفصول التجريدية : عدد الفصول التجريدية.
• عدد الواجهة : إجمالي عدد الواجهات.
• عدد الأسلوب : إجمالي عدد الأساليب ، بما في ذلك الأساليب العامة والخاصة والثابتة.
• الأساليب العامة : عدد الأساليب العامة.
• الطرق الخاصة : عدد الأساليب الخاصة.
• طرق ثابتة : عدد الأساليب الثابتة.
• بيانات الإخراج : عدد مكالمات الصدى و printf.
• خطوط التعليمات البرمجية (LOC) : إجمالي أسطر الكود ، بما في ذلك التعليقات والخطوط الفارغة.
• الخطوط المنطقية للرمز (LLOC) : إجمالي خطوط الكود باستثناء التعليقات والخطوط الفارغة.
• خطوط التعليق من الكود (CLOC) : خطوط الكود التي تحتوي على تعليقات.
• خطوط HTML من التعليمات البرمجية : خطوط الكود التي تحتوي على HTML.
• التعقيد السيكلومي (CC) : مقياس لتعقيد الكود.
• مؤشر الصيانة (MI) : فهرس يشير إلى قابلية الصيانة للرمز.
• LCOM : عدم تماسك الأساليب في الفصول.
• عدم الاستقرار : قياس استقرار الفصل بناءً على تبعياته.
• اقتران فعال (CE) : عدد الفئات التي يعتمد عليها الفصل.
• اقتران Afferent (CA) : عدد الفصول التي تعتمد على الفصل.
• الصعوبة : قياس مدى صعوبة الفهم.
• الجهد : تقدير الجهد المطلوب لفهم الكود.
• المفردات : عدد المشغلين الفريدين والمعاملات في الكود.
• الطول : إجمالي عدد المشغلين والمعاملات في الكود.
• المجلد : حجم المفردات والطول للرمز.
• وزن التعليق : وزن التعليقات في الكود.
• المسافة من الخط الرئيسي : قياس مدى استقرار الفئة المجردة والمستقرة.

فيما يلي عينة لقطة شاشة لتقرير HTML:

الوثائق

أنا أعمل حاليًا على الوثائق. نظرًا لأنني أستخدم الأداة في المقام الأول لمشاريعي الخاصة وأركز على تطويرها المستمر ، فقد يستغرق الأمر بعض الوقت لإكمال وثائق شاملة.

مؤلف

ماركوس كوبر ، mrcskbr ، جيثب