Để khai thác tối đa tiềm năng của PHP và đảm bảo dự án của bạn vận hành trơn tru, bền vững, việc tuân thủ các tiêu chuẩn viết code là không thể bỏ qua. Trong bài viết này, chúng ta sẽ cùng nhau đi sâu vào các quy tắc và thực hành tốt nhất khi viết code PHP, giúp bạn xây dựng những ứng dụng web chất lượng cao, dễ bảo trì và mở rộng.
Lợi ích việc tuân thủ các tiêu chuẩn cơ bản khi viết code trong PHP
- Những người làm trong các module khác nhau dễ dàng quản lý các source code.
- Trở thành bản kế hoạch chi tiết cho các thành viên khác hiểu, quản lý, thay đổi.
- Tiết kiệm rất nhiều thời gian khắc phục các lỗi thông thường nhờ sự dễ hiểu.
- Tiêu chuẩn viết code, tiêu chuẩn công nghiệp cải thiện chất lượng, tính nhất quán của phần mềm.
Các tiêu chuẩn chung
- PHP tags: Buộc phải sử dụng thẻ PHP đề ra, thay vì thẻ tốc ký để phân định code PHP.
Full tags:
<?PHP
PHP code
?>Short tags:
<?
PHP code
?>- Comments:
Thường sử dụng theo chuẩn của C và C++ là // cho dòng đơn và /* */ cho nhiều dòng. Khuyến khích dùng theo chuẩn Python hoặc Perl là #
- Độ dài của dòng, lùi đầu dòng (Line length and Indentation):
Khuyến nghị tiêu chuẩn sẽ là không vượt quá 75-85 ký tự cho một dòng. Thay vì dùng tab, dùng space cho tiêu chuẩn chung hầu hết các ngôn ngữ lập trình hiện nay. Thường một câu lệnh cho một dòng, nhiều lệnh dài sẽ chia dòng.
- Cấu trúc điều khiển (Control structures):
Luồng điều khiển (control flow) hoặc các lệnh điều kiện buộc phải viết theo cách mà phân biệt được với các lệnh gọi hàm. Khi dùng lệnh if, for, else, foreach, do, while, switch,… và các lệnh tương tự khác buộc phải có khoảng cách giữa tự khóa và dấu ngoặc mở.
- Gọi hàm (function calls):
Không nên có khoảng cách giữa các tham số, dấu phẩy, tham số cuối cùng hay dấu chấm phẩy. Luôn dùng PHP tags cũng như tránh dùng tags tốc ký khác (nếu không sẽ có thể gây lỗi). Toán tử = nên thêm khoảng trắng ở hai phía trươc sau.
- Các ví dụ:
<?php
$n = 5;
if ($n > 0){
echo "Positive";
}
elseif ($n < 0){
echo "Negative";
}
else{
echo "Zero";
}
?>Bạn sẽ có output là Positive. Trong ví dụ khác:
<?php
echo testFunc(5, 6);
function testFunc($num1, $num2) {
$val = $num1 + $num2;
return $val;
}
?>Output lúc này sẽ là 11.
- Đặt tên biến (Naming variables):
- Nên dùng chữ thường để đặt tên biến.
- Dùng dấu gạch dưới (“_”) để tách các từ trong một biến.
- Tên biến không nên bắt đầu bằng số.
- Tên biến tĩnh có thể bắt đầu bằng chữ “s” (viết tắt của “static”).
- Tên biến toàn cục có thể bắt đầu bằng chữ “g” (viết tắt của “global”).
- Nên dùng chữ IN HOA để đặt tên hằng số, kèm dấu gạch dưới (“_”) để phân cách các từ.
- Định dạng code:
- Block alignment: Mỗi khối lệnh nên được căn lề đúng hàng, cột.
- Short function: Hàm và phương thức nên được viết ngắn gọn, lý tưởng là không quá 50 dòng.
Mọi người cũng xem:
Lời kết
Vietnix hy vọng qua bài viết này sẽ giúp bạn nắm được các tiêu chuẩn cơ bản khi viết code trong PHP. Từ đó dễ dàng quản lý, đọc hiểu, lưu trữ và triển khai các project giữ các thành viên trong nhóm, giữa các nhà phát triển dự án. Ngoài ra, bạn cũng có thể tham khảo thêm các bài viết khác tại vietnix.vn để hiểu hơn về lập trình, chúc bạn thành công!
