PHP CODING STANDARD










Hà nội, <13/11/2006 >

GHI NHẬN THAY ĐỔI

*A – Thêm mới M – Sửa đổi D - Xóa
Ngày hiệu lực
Mục thay đổi
A* M, D
Mô tả
Phiên bản mới
































































































































CHỮ KÝ VÀ PHÊ DUYỆT




XÂY DỰNG: Nguyễn Văn Ba Ngày
Leader
Trương Kiều Linh
Developer

ĐÁNH GIÁ: Ngô Khánh Hoàng Ngày
Vice Director

< Tên, nếu cần> Ngày
< Vị trí >

PHÊ DUYỆT: Kientt Ngày
Director
MỤC LỤC TÀI LIỆU
1 GIỚI THIỆU CHUNG 63
1.1 Mục đích tài liệu 63
1.2 Phạm vi tài liệu 63
2 PHP FILE FORMATTING 73
2.1 Ký hiệu kết thúc file 73
2.2 Quy định lề đầu dòng 73
2.3 Giới hạn code trên 1 dòng 73
3 NAMING CONVENTIONS 83
3.1 Lớp 83
3.2 Interface 83
3.3 Tên thư mục, file 83
3.4 Hàm và phương thức 93
3.5 Biến 103
3.6 Hằng 113
3.7 My Sql Conventions 123
4 CODING STYLE 133
4.1 PHP Code Demarcation 133
4.2 String 133
4.3 Mảng 143
4.4 Lớp 143
Khai báo lớp 143
Biến 153
4.5 Hàm và phương thức 153
4.6 Câu lệnh điều khiển 163
4.7 If / Else / Elseif 163
4.7.1 Switch 173
4.7.2 Continue,break and ?: 173
4.8 Cách trình bày cho các khối 183
4.9 Comment 193
4.9.1 Documentation Format 193
4.9.2 Files 193
4.9.3 Lớp 193
4.9.4 Hàm 193
4.9.5 Biến 203
4.9.6 Gotcha Keywords 203
GIỚI THIỆU CHUNG
Mục đích tài liệu
Một coding standard tốt hết sức quan trọng cho bất kỳ một dự án phần mềm nào, nhất là đối với các dự án nhiều người. Coding standard góp một phần lớn tron việc đảm bảo chất lượng source code, ít lỗi và dễ bảo trì.
Phạm vi tài liệu
Tài liệu này cung cấp coding standards và guidelines cho các lập trình viên trong tất cả các dự án viết trên ngôn ngữ PHP của trung tâm phần mềm QSoftVietnam.

PHP FILE FORMATTING
Ký hiệu kết thúc file
Đối với những file chỉ gồm code php không được dùng thẻ đóng (“?>”). Điều kiện trên không yêu cầu bởi PHP engine nhưng việc không dùng thẻ đóng prevents trailing whitespace from being accidentally injected into the output.tránh được việc bị tràn new line khi output ra HTML page.
Quy định lề đầu dòng
Sử dụng 1 tab cho mỗi level.
Trong các chuẩn coding khác thường quy ước dùng 4 khoảng trắng thay cho dung tab. Lý do của cách dung này là do trong các editor khác nhau độ dài của tab khác nhau dẫn đến có thể không thống nhất trong việc hiển thị code. Tuy nhiên do tính thống nhất trong môi trường lập trình tại trung tâm nên việc sử dụng Tab không bị các nhược điểm trên. Ngược lại có một số ưu điểm:
Tăng tốc độ di chuyển của con trỏ thay vì phải di chuyển 4 space thì chỉ phải di chuyển 1 tab
Tăng tốc độ thực hiện dòng code
Giới hạn code trên 1 dòng
Việc giới hạn số ký tự trên 1 dòng code nhằm giúp cho lập trình viên nhìn code được dễ dàng. Một dòng code nên chỉ có 80 ký tự và tối đa là 120 ký tự.
NAMING CONVENTIONS
Lớp
Chữ cái đầu tiên viết hoa