PHP - Coding Standard

Mỗi công ty đều tuân theo tiêu chuẩn mã hóa riêng dựa trên các thực tiễn tốt nhất của họ. Tiêu chuẩn mã hóa là cần thiết vì có thể có nhiều nhà phát triển làm việc trên các mô-đun khác nhau, vì vậy nếu họ bắt đầu sáng tạo ra các tiêu chuẩn riêng của mình thì mã nguồn sẽ trở nên rất khó quản lý và sẽ khó duy trì mã nguồn đó trong tương lai.

Dưới đây là một số lý do tại sao mọi người nên sử dụng các quy định lập trình −

  • Các lập trình viên đồng nghiệp của bạn phải hiểu mã mà bạn sản xuất. Một tiêu chuẩn lập trình hoạt động như một bản thiết kế cho toàn bộ nhóm để giải mã mã nguồn.

  • Sự đơn giản và rõ ràng đạt được nhờ mã hóa nhất quán sẽ giúp bạn tránh khỏi những sai lầm phổ biến.

  • Nếu bạn chỉnh sửa mã của mình sau một thời gian, thì sẽ dễ dàng hơn để hiểu đoạn mã đó.

  • Việc tuân theo một tiêu chuẩn mã hóa đồng nhất mang lại chất lượng cao hơn cho phần mềm.

Có một vài hướng dẫn có thể được tuân theo khi lập trình bằng PHP.

Indenting and Line Length

Sử dụng thụt lề 4 dấu cách và không sử dụng tab vì các máy tính khác nhau có cài đặt khác nhau cho tab. Nên giữ độ dài dòng khoảng 75-85 ký tự để cải thiện khả năng đọc mã.

Control Structures

Các câu lệnh điều khiển bao gồm if, for, while, switch, v.v. Các câu lệnh điều khiển nên có một khoảng cách giữa từ khóa điều khiển và dấu ngoặc mở, để phân biệt chúng với các lời gọi hàm. Bạn nên luôn sử dụng dấu ngoặc nhọn ngay cả trong những tình huống mà chúng về mặt kỹ thuật là tùy chọn.

Examples

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

Bạn có thể viết các câu switch như sau:

switch (condition) {
   case 1:
      action1;
      break;

   case 2:
      action2;
      break;

   default:
      defaultaction;
      break;
}

Function Calls

Các hàm nên được gọi mà không có khoảng trắng giữa tên hàm, dấu ngoặc mở và tham số đầu tiên; có khoảng trắng giữa các dấu phẩy và mỗi tham số, và không có khoảng trắng giữa tham số cuối cùng, dấu ngoặc đóng và dấu chấm phẩy. Dưới đây là một ví dụ −

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

Function Definitions

Các khai báo hàm theo "kiểu BSD/Allman" −

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

Comments

Các chú thích theo kiểu C (/* */) và các chú thích chuẩn C++ (//) đều được chấp nhận. Việc sử dụng chú thích theo kiểu Perl/shell (#) là được phép nhưng không khuyến khích.

PHP Code Tags

Luôn sử dụng <?php ?> để phân định mã PHP, không sử dụng ký hiệu tắt <? ?>. Điều này là cần thiết để tuân thủ PHP và cũng là cách bao gồm mã PHP di động nhất trên các hệ điều hành và cấu hình khác nhau.

Variable Names

  • sử dụng tất cả các chữ cái thường

  • Sử dụng '_' làm dấu phân cách từ.

  • Các biến toàn cục nên được thêm tiền tố 'g'.

  • Các hằng số toàn cục nên được viết bằng chữ in hoa và sử dụng dấu '_' để phân tách.

  • Các biến tĩnh có thể được thêm tiền tố 's'.

Make Functions Reentrant

Các hàm không nên giữ các biến tĩnh ngăn cản một hàm có thể được gọi lại (reentrant).

Alignment of Declaration Blocks

Khối khai báo nên được căn chỉnh.

One Statement Per Line

Chỉ nên có một câu lệnh trên mỗi dòng trừ khi các câu lệnh đó có liên quan rất chặt chẽ với nhau.

Short Methods or Functions

Các phương thức nên giới hạn mình trong một trang mã.

Có thể có nhiều điểm khác nữa cần được xem xét khi viết chương trình PHP của bạn. Mục đích tổng thể nên là duy trì tính nhất quán trong toàn bộ mã lập trình, và điều này chỉ có thể thực hiện được khi bạn tuân thủ bất kỳ tiêu chuẩn lập trình nào. Bạn có thể tạo ra tiêu chuẩn riêng của mình nếu bạn thích điều gì đó khác biệt.