Hướng dẫn này kế thừa và mở rộng thêm cho Psr - 1 : Tiêu chuẩn cơ bản khi viết code.
Tổng quan về trình bày code PHP
- Code
PHẢI
tuân thủ PSR-1 - Code
PHẢI
sử dụng 4 ký tự space để lùi khối [không dùng tab] -
KHÔNG PHẢI
cố định chiều dài của dòng code; dòng codePHẢI
dưới 120 ký tự;NÊN
dưới hoặc bằng 80 ký tự. PHẢI
có một dòng trắng sau khai báo namespace, vàPHẢI
có một dòng trắng sau mỗi khối code.- Ký tự mở { khai báo lớp
PHẢI
ở dòng tiếp theo, và đóng }PHẢI
ở dòng tiếp theo sau thân class. - Ký tự { cho hàm
PHẢI
ở dòng tiếp theo, và ký tự } kết thúc hàmPHẢI
ở dòng tiếp theo của thân hàm. - Các visibility [public, private,
protected]
PHẢI
được khai báo cho tất cả các hàm và các thuộc tính của lớp; abstract và finalPHẢI
được khai báo trước visibility.static
phải khai báo sauvisibility
- Các từ khóa điều khiển khối [if, elseif, else]
PHẢI
có một khoảng trống sau chúng; gọi hàm, phương thức thìKHÔNG ĐƯỢC
làm như vậy. - Mở khối { cho cấu trúc điều khiển
PHẢI
trên cùng một dòng; và đóng khối này } với ở dòng tiếp theo của thân khối. - Hằng số
true
,false
,null
PHẢI
viết với chữ thường. - Từ khóa
extends
vàimplements
phải cùng dòng vớiclass
. - implements nhiều lớp, thì mỗi lớp trên một dòng
- keyword
var
KHÔNG ĐƯỢC
dùng sử dụng khai báo property. - Tên property KHÔNG NÊN có tiền tố _ nhằm thể hiện thuộc protect hay private.
- Tham số cho hàm, phương thức: KHÔNG được thêm space vào trước dấu
,
vàPHẢI
có một space sau,
. Các tham sốCÓ THỂ
trên nhiều dòng, nếu làm như vậy thìPHẢI
mỗi dòng 1 tham số. abstract
,final
PHẢI đứng trướcvisibility
, cònstatic
phải đi sau.
$b] {
$foo->bar[$arg1];
} else {
BazClass::bar[$arg2, $arg3];
}
}
final public static function bar[]
{
// method body
}
}