PHP - มาตรฐานการเข้ารหัส

ทุก บริษัท ปฏิบัติตามมาตรฐานการเข้ารหัสที่แตกต่างกันตามแนวทางปฏิบัติที่ดีที่สุด จำเป็นต้องมีมาตรฐานการเข้ารหัสเนื่องจากอาจมีนักพัฒนาจำนวนมากที่ทำงานในโมดูลต่างๆดังนั้นหากพวกเขาจะเริ่มคิดค้นมาตรฐานของตนเองซอร์สจะไม่สามารถจัดการได้อย่างมากและจะเป็นการยากที่จะรักษาซอร์สโค้ดนั้นในอนาคต

นี่คือสาเหตุหลายประการที่ต้องใช้ข้อกำหนดการเข้ารหัส -

• โปรแกรมเมอร์เพื่อนของคุณต้องเข้าใจรหัสที่คุณผลิต มาตรฐานการเข้ารหัสทำหน้าที่เป็นพิมพ์เขียวสำหรับทุกทีมในการถอดรหัสรหัส

• ความเรียบง่ายและชัดเจนที่ได้จากการเข้ารหัสที่สม่ำเสมอช่วยให้คุณประหยัดจากข้อผิดพลาดทั่วไป

• หากคุณแก้ไขโค้ดของคุณหลังจากผ่านไประยะหนึ่งคุณจะเข้าใจรหัสนั้นได้ง่าย

• มาตรฐานอุตสาหกรรมเป็นไปตามมาตรฐานเฉพาะเพื่อให้ซอฟต์แวร์มีคุณภาพมากขึ้น

มีหลักเกณฑ์บางประการที่สามารถปฏิบัติตามได้ในขณะที่เขียนโค้ดใน PHP

• Indenting and Line Length- ใช้การเยื้อง 4 ช่องว่างและอย่าใช้แท็บใด ๆ เนื่องจากคอมพิวเตอร์เครื่องอื่นใช้การตั้งค่าที่แตกต่างกันสำหรับแท็บ ขอแนะนำให้บรรทัดยาวประมาณ 75-85 อักขระเพื่อให้อ่านโค้ดได้ดีขึ้น

• Control Structures- ซึ่งรวมถึง if, for, while, switch และอื่น ๆ คำสั่งควบคุมควรมีช่องว่างระหว่างคีย์เวิร์ดควบคุมและวงเล็บเปิดเพื่อแยกความแตกต่างจากการเรียกฟังก์ชัน ขอแนะนำให้คุณใช้วงเล็บปีกกาเสมอแม้ในสถานการณ์ที่เป็นทางเลือกในทางเทคนิค

Examples

if ((condition1) || (condition2)) {
   action1;
}elseif ((condition3) && (condition4)) {
   action2;
}else {
   default action;
}

คุณสามารถเขียนคำสั่ง switch ได้ดังนี้ -

switch (condition) {
   case 1:
      action1;
      break;
   
   case 2:
      action2;
      break;
         
   default:
      defaultaction;
      break;
}

• Function Calls- ควรเรียกใช้ฟังก์ชันโดยไม่มีช่องว่างระหว่างชื่อฟังก์ชันวงเล็บเปิดและพารามิเตอร์แรก ช่องว่างระหว่างเครื่องหมายจุลภาคและแต่ละพารามิเตอร์และไม่มีช่องว่างระหว่างพารามิเตอร์สุดท้ายวงเล็บปิดและอัฒภาค นี่คือตัวอย่าง -

$var = foo($bar, $baz, $quux);

• Function Definitions - การประกาศฟังก์ชันเป็นไปตาม "สไตล์ BSD / Allman" -

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

• Comments- ความคิดเห็นสไตล์ C (/ * * /) และความคิดเห็นมาตรฐาน C ++ (//) ใช้ได้ทั้งคู่ ไม่แนะนำให้ใช้ความคิดเห็นรูปแบบ Perl / shell (#)

• PHP Code Tags- ใช้ <? php?> เพื่อคั่นโค้ด PHP เสมอไม่ใช่ <? ?> ชวเลข. สิ่งนี้จำเป็นสำหรับการปฏิบัติตามข้อกำหนดของ PHP และยังเป็นวิธีพกพามากที่สุดในการรวมโค้ด PHP บนระบบปฏิบัติการและการตั้งค่าที่แตกต่างกัน

• Variable Names -

  • ใช้อักษรตัวพิมพ์เล็กทั้งหมด
  • ใช้ '_' เป็นตัวคั่นคำ
  • ตัวแปรส่วนกลางควรนำหน้าด้วย "g"
  • ค่าคงที่ส่วนกลางควรเป็นตัวพิมพ์ใหญ่ทั้งหมดที่มีตัวคั่น "_"
  • ตัวแปรคงที่สามารถนำหน้าด้วย "s" ได้

• Make Functions Reentrant - ฟังก์ชั่นไม่ควรเก็บตัวแปรคงที่ที่ป้องกันไม่ให้ฟังก์ชันกลับเข้ามาใหม่

• Alignment of Declaration Blocks - บล็อกการประกาศควรจัดแนว

• One Statement Per Line - ควรมีเพียงหนึ่งคำสั่งต่อบรรทัดเว้นแต่ว่าคำสั่งนั้นเกี่ยวข้องกันมาก

• Short Methods or Functions - วิธีการควร จำกัด ตัวเองให้อยู่ในโค้ดหน้าเดียว

อาจมีจุดอื่น ๆ อีกมากมายที่ควรพิจารณาในขณะเขียนโปรแกรม PHP ของคุณ ความตั้งใจทั้งหมดควรจะสอดคล้องกันตลอดการเขียนโปรแกรมโค้ดและจะเป็นไปได้ก็ต่อเมื่อคุณจะปฏิบัติตามมาตรฐานการเข้ารหัสใด ๆ คุณสามารถกำหนดมาตรฐานของคุณเองได้หากคุณชอบสิ่งที่แตกต่าง