จัดระเบียบโค้ด PHP ก่อนแชร์

ทำไมการจัดรูปแบบจึงช่วยผู้อ่าน

คนอ่านโค้ดโดยดูจากรูปร่างของมัน เมื่อวงเล็บตรงแนวกันและแต่ละคำสั่งมีบรรทัดของตัวเอง ผู้อ่านจะเห็นโครงสร้างก่อนที่จะอ่านคำใดคำหนึ่ง ผู้ตรวจทานจึงสังเกตวงเล็บที่ขาดหรือลูปที่อยู่ผิดตำแหน่งได้ง่าย ข้อความที่เป็นก้อนเดียวไม่มีบรรทัดแบ่ง จึงซ่อนสิ่งเหล่านี้ไว้ทั้งหมด

ก่อนและหลัง

โค้ดต้นฉบับ คัดลอกมาจากล็อก:

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

หลังจัดระเบียบด้วยการเยื้อง 4 ช่องว่าง:

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

รายการตรวจสอบสั้น ๆ ก่อนโพสต์

• ลบข้อมูลลับออก ข้อความที่คุณวางที่นี่จะถูกประมวลผลบนเซิร์ฟเวอร์ของเรา ดังนั้นอย่าใช้ข้อมูลยืนยันตัวตนจริง โทเค็น หรือข้อมูลลูกค้า
• ทำให้ตัวอย่างเรียบง่าย เก็บเฉพาะบรรทัดที่จำเป็นเพื่อแสดงปัญหา
• ระบุเวอร์ชัน PHP ที่คุณใช้ และผลลัพธ์ที่คุณคาดหวัง
• เทียบโค้ดที่จัดรูปแบบแล้วกับต้นฉบับ เครื่องมือนี้เปลี่ยนเฉพาะการจัดวาง แต่กฎเรื่องช่องว่างอาจกระทบคอมเมนต์และสตริงได้
• ใส่ผลลัพธ์ไว้ในบล็อกโค้ด เพื่อให้การเยื้องยังคงอยู่

เครื่องมือนี้ไม่ได้ทำอะไร

เครื่องมือนี้ไม่ได้ค้นหาข้อผิดพลาด ไม่ได้รันโค้ด และไม่ได้ตรวจกฎสไตล์ การจัดวางที่สะอาดทำให้ปัญหาเห็นได้ง่ายขึ้น แต่ไม่ได้แก้ปัญหาให้

ใช้ได้ในกรณีใดบ้าง

• ตั๋วงานสนับสนุนหรือรายงานบั๊กที่มีตัวอย่างโค้ด
• คำถามในฟอรัมนักพัฒนาหรือช่องแชต
• หน้าเอกสารหรือบทแนะนำที่ตัวอย่างโค้ดต้องดูเรียบร้อย
• ความคิดเห็นในการตรวจโค้ดที่เสนอให้เปลี่ยนบางส่วนของฟังก์ชัน

ในทุกกรณี ผู้อ่านจะเห็นโครงสร้างก่อนแล้วจึงเห็นปัญหา ซึ่งเป็นลำดับที่คุณต้องการ

ทำให้โค้ดตัวอย่างซื่อตรง

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