Code convention – tạm dịch là quy ước viết code, có thể được hiểu đơn giản là tập hợp những nguyên tắc chung khi lập trình như đặt tên biến, hàm, file, class, comment,… nhằm giúp cho code dễ đọc, dễ hiểu hơn vì vậy dễ bảo trì và sửa lỗi hơn. Bài viết dưới đây sẽ cung cấp thông tin về quy tắc viết code conventions.
- Tên app/project
- Quy ước: Danh từ, chữ hoa từng đầu từ, trừ tình huống đặc biệt về nhận dạng thương hiệu (iCloud). Không dùng khoảng trắng, dấu tiếng Việt, và các kí tự đặc biệt.
- Ví dụ: StudentManagement, HelloWorld, PetCareSystem
2. Tên package/thư mục chứa code
- Quy ước: Danh từ, chữ thường, cố gắng từ đơn, các thư mục con phân cách nhau bởi dấu chấm. Không dùng khoảng trắng, dấu tiếng Việt, và các kí tự đặc biệt. Theo lẽ thường, package gốc dùng phần đuôi của tên miền của tổ chức, ví dụ com, edu. gov. Thư mục/package mức con tùy thuộc vào quy tắc tổ chức các thành phần code của dự án.
- Ví dụ: com.apple.quicktime, util, data, edu.fpt.util
3. Tên class/sự phân nhóm đối tượng – Tên interface
- Quy ước: Danh từ, chữ hoa từng đầu từ. Viết cả từ, tránh viết tắt.
- Ví dụ: Dog, Cat, File, String, Student, Person
4. Tên biến/tên vùng nhớ RAM, chứa data
- Quy ước biến thường: Danh từ, chữ hoa từng đầu từ, từ đầu tiên viết chữ thường (cú pháp con lạc đà, camel case notation). Nên đặt tên biến có ý nghĩa/theo mục đích sử dụng, tránh viết tắt trừ những biến tạm thời (biến trung gian t, tmp, biến đếm i, j, k).
- Ví dụ: luongCoBan, dienTich, chuVi, basicSalary, yearOfBirth
- Quy ước hằng số (const, final): Danh từ, chữ hoa tất cả các từ, gạch dưới _dùng để kết nối các từ.
- Ví dụ: THUE_GIA_TRI_GIA_TANG, VAT, VALUE_ADDED_TAX, MAX_SPEED, MAX_ELEMENTS, PI
5. Tên function/method/hàm, diễn tả hành động, xử lí
- Quy ước: Verb + Object, động từ kèm theo bổ ngữ, chữ hoa từng đầu từ, từ đầu tiên viết chữ thường (cú pháp con lạc đà, camel case notation).
- Ví dụ: tinhLuong(), computeArea(), getSalary(), showInfo(), sort(), sortByName()
6. Indentation/gióng lề cho code
- Quy ước: Mặc định các đoạn code mức con sẽ thụt vào so với mức cha 4 khoảng trắng (tương đương 1 phím tab).
- Ví dụ: if ((gpa >= 9) && (gpa <= 10))
System.out.println(“You are excellence”);
- Quy ước: Lưu ý dấu cách trong các thành phần của biểu thức, phép gán, câu lệnh.
- Ví dụ: int a=10; //sai chuẩn
int a = 10; //đúng chuẩn
Giảng viên Nguyễn Quang Hiếu
Bộ môn Công nghệ thông tin
FPT Polytechnic Hải Phòng
Hỗ trợ tư vấn và giải đáp thông tin tuyển sinh FPT Polytechnic
