PhpCodeArcheology

phpcodearcheology

PHPCodearcheology วิเคราะห์โครงการ PHP ของคุณโดยให้รายละเอียดตัวชี้วัดรายละเอียดเกี่ยวกับไฟล์คลาสวิธีการและฟังก์ชั่น รายงาน HTML ที่ครอบคลุมช่วยให้คุณมีข้อมูลเชิงลึกที่จำเป็นสำหรับการประเมินโครงการของคุณ

ทำไม phpcodearcheology?

PHPCodearcheology ถูกสร้างขึ้นเพื่อช่วยให้นักพัฒนาได้รับความเข้าใจที่ลึกซึ้งยิ่งขึ้นเกี่ยวกับ PHP Codebase ของพวกเขาโดยให้รายละเอียดตัวชี้วัดและข้อมูลเชิงลึก ไม่ว่าคุณจะยังคงรักษาระบบดั้งเดิมหรือทำงานในโครงการใหม่เครื่องมือนี้มีวัตถุประสงค์เพื่ออำนวยความสะดวกในคุณภาพของรหัสและการบำรุงรักษาที่ดีขึ้น

ข้อกำหนดเบื้องต้น

ตรวจสอบให้แน่ใจว่าสภาพแวดล้อมของคุณตรงตามข้อกำหนดดังต่อไปนี้:

• 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 รวมถึงตัวชี้วัดเช่น:

• ไฟล์ : จำนวนไฟล์ทั้งหมดในโครงการ
• ข้อผิดพลาดของไฟล์ : จำนวนข้อผิดพลาดที่พบในไฟล์
• จำนวนฟังก์ชั่น : จำนวนฟังก์ชั่นทั้งหมด
• จำนวนคลาส : จำนวนคลาสทั้งหมด
• คลาสบทคัดย่อ : จำนวนคลาสนามธรรม
• จำนวนอินเตอร์เฟส : จำนวนอินเตอร์เฟสทั้งหมด
• จำนวนวิธี : จำนวนวิธีทั้งหมดรวมถึงวิธีการสาธารณะส่วนตัวและแบบคงที่
• วิธีการสาธารณะ : จำนวนวิธีการสาธารณะ
• วิธีการส่วนตัว : จำนวนวิธีส่วนตัว
• วิธีการคงที่ : จำนวนวิธีการคงที่
• คำสั่งเอาท์พุท : จำนวนการโทร echo และ printf
• บรรทัดของรหัส (loc) : บรรทัดทั้งหมดของรหัสรวมถึงความคิดเห็นและบรรทัดที่ว่างเปล่า
• บรรทัดตรรกะของรหัส (LLOC) : บรรทัดทั้งหมดของรหัสไม่รวมความคิดเห็นและบรรทัดที่ว่างเปล่า
• บรรทัดความคิดเห็นของรหัส (CLOC) : บรรทัดของรหัสที่มีความคิดเห็น
• บรรทัด HTML ของรหัส : บรรทัดของรหัสที่มี HTML
• ความซับซ้อนของ Cyclomatic (CC) : การวัดความซับซ้อนของรหัส
• ดัชนีการบำรุงรักษา (MI) : ดัชนีที่ระบุความสามารถในการบำรุงรักษาของรหัส
• LCOM : ขาดการทำงานร่วมกันของวิธีการในชั้นเรียน
• ความไม่แน่นอน : การวัดเสถียรภาพของชั้นเรียนตามการพึ่งพา
• การมีเพศสัมพันธ์ (CE) : จำนวนคลาสที่คลาสขึ้นอยู่กับ
• Afferent coupling (CA) : จำนวนคลาสที่ขึ้นอยู่กับชั้นเรียน
• ความยาก : วัดว่ารหัสยากแค่ไหนที่จะเข้าใจ
• ความพยายาม : การประเมินความพยายามที่จำเป็นในการทำความเข้าใจรหัส
• คำศัพท์ : จำนวนผู้ให้บริการที่ไม่ซ้ำกันและตัวถูกดำเนินการในรหัส
• ความยาว : จำนวนผู้ให้บริการและตัวถูกดำเนินการทั้งหมดในรหัส
• ปริมาณ : ขนาดของคำศัพท์และความยาวของรหัส
• ความคิดเห็นน้ำหนัก : น้ำหนักของความคิดเห็นในรหัส
• ระยะทางจากสายหลัก : การวัดว่าคลาสที่เป็นนามธรรมและความเสถียรเป็นอย่างไร

นี่คือภาพหน้าจอตัวอย่างของรายงาน HTML:

เอกสาร

ฉันกำลังทำงานเกี่ยวกับเอกสาร เนื่องจากฉันใช้เครื่องมือสำหรับโครงการของตัวเองเป็นหลักและมุ่งเน้นไปที่การพัฒนาอย่างต่อเนื่องอาจใช้เวลาสักครู่ในการทำเอกสารที่ครอบคลุม

ผู้เขียน

Marcus Kober, @MRCSKBR, GitHub