Chuẩn viết code trong PHP

Mỗi một công ty sẽ có chuẩn code khác nhau dựa trên thực tiễn công việc của họ. Chuẩn code là cần thiết bởi vì có thể có nhiều lập trình viên làm việc trên những modun khác nhau, vì thế, nếu họ bắt đầu phát minh ra những chuẩn riêng, thì sau đó mã nguồn sẽ trở thành một đống hổ lốn, khó quản lý và khó duy trì mã nguồn trong tương lai.

Dưới đây là các lý do tại sao mà phải sử dụng thông số kỹ thuật code:

  • Lập trình viên đang làm việc cùng bạn phải hiểu được code mà bạn đã tạo. Một chuẩn code chung hoạt động với vai trò như là blueprint cho mọi thành viên tham gia dự án đó trong team.
  • Tính đơn giản và rõ ràng có thể thực hiện được bởi cách code phù hợp sẽ giúp bạn giảm đi những sai lầm phổ biến.
  • Không phải code viết một lần là xong, đôi khi bạn sẽ phải xem, sửa lại code của mình, với những chuẩn code đã thống nhất từ trước, bạn sẽ dễ dàng hiểu những dòng code mình đã viết, việc xem/sửa lại cũng thuận lợi hơn.
  • Tiêu chuẩn công nghiệp của nó tuân theo một tiêu chuẩn cụ thể để có được chất lượng tốt hơn trong phần mềm.

Dưới đây là một vài hướng dẫn bạn nên theo khi viết code trong lập trình PHP:

Thụt đầu dòng và độ dài dòng code − Tạo thụt đầu dòng bằng cách nhấn 4 lần phím cách (phím space) và không sử dụng bất kỳ phím tab nào bởi vì các máy tính khác nhau sử dụng thiết lập khác nhau cho phím tab. Về độ dài dòng code, bạn nên giữ dòng code có độ dài khoảng 75-85 ký tự, việc này giúp code của bạn trở nên dễ đọc hơn.

Cấu trúc điều khiển − Nó bao gồm if, for, while, switch,… Giữa các từ khóa này và dấu mở ngoặc nên có một dấu cách (nhấn 1 lần phím cách) để phân biệt chúng với các lời gọi hàm. Bạn được khuyến khích mạnh mẽ để luôn luôn sử dụng dấu ngoặc nhọn bất cứ khi nào có thể.

Ví dụ

if ((điều_kiện1) || (điều_kiện2)) { hành động cần thực thi 1; }elseif ((điều_kiện3) && (điều_kiện4)) { hành động cần thực thi 2; }else { default hành động cần thực thi mặc định; }

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

switch (điều_kiện) {
case 1:
hành động cần thực thi
break;

case 2:
hành động cần thực thi
break;

default:
hành động mặc định
break;
}

Lời gọi hàm − Khi gọi hàm, giữa tên hàm, dấu ngoặc mở và biến đầu tiên nên viết liền, không có khoảng trắng; thêm khoảng trắng giữa dấu phảy và từng tham số, và không có khoảng trắng giữa tham số cuối, 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);

Định nghĩa hàm − Khai báo hàm theo "BSD/Allman style".

function fooFunction($arg1, $arg2 = ''){
if (điều_kiện) {
lệnh cần thực thi
}
return $val;
}

Comment − Comment theo ngôn ngữ C (/ /) và theo chuẩn C++ (//) cả 2 đều OK. Cách sử dụng comment theo kiểu của Perl/shell (#) không khuyến khích.

Thẻ PHP code − Luôn luôn sử dụng <?php ?> để xác định phạm vi PHP code, không dùng cách viết tắt <? ?>.

Tên biến:

  • Sử dụng tất cả là chữ thường.
  • Sử dụng dấu gạch dưới (_) như một kí tự phân cách.
  • Biến toàn cục (global) nên được thêm vào trước một chữ "g".
  • Hằng toàn cục nên là chữ hoa với ký tự phân tách là dấu gạch dưới (_).
  • Biến tĩnh (static) nên được thêm vào trước một chữ "s".

Tạo các hàm Reentrant (đồng dụng) − Các hàm không nên chứa biến tĩnh mà ngăn cản một hàm từ việc có thể đồng dụng (reentrant).

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

1 lệnh trên 1 dòng − 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ẽ.

Hàm và phương thức ngắn − Các phương thức nên được giới hạn trong một trang code.

Có thể có nhiều hướng dẫn, quy tắc khác được nhắc đến khi viết code bằng PHP. Tốt nhất, tất cả các quy tắc, hướng dẫn đó nên được thống nhất trong suốt quá trình code và điều này chỉ xảy ra khi bạn làm theo chuẩn code nào đó. Bạn có thể có chuẩn của riêng bạn nếu bạn thích tạo sự khác biệt.

Theo tutorialspoint

Bài trước: Upload File trong PHP

Bài tiếp: Biến được định nghĩa trước trong PHP

Thứ Năm, 26/07/2018 17:19
51 👨 403