I. Định Nghĩa Coding Convention

Coding convention là tập hợp các quy tắc và tiêu chuẩn mà lập trình viên cần tuân theo trong quá trình viết mã nguồn. Các quy tắc này không chỉ bao gồm những điều cơ bản như đặt tên, quy định về số lượng, xuống dòng và comment, mà còn có thể thay đổi theo từng ngôn ngữ lập trình.

Việc tuân thủ coding convention giúp đảm bảo tính nhất quán, nâng cao khả năng đọc hiểu và dễ dàng bảo trì mã nguồn. Nhờ vậy, các thành viên trong nhóm có thể tiết kiệm thời gian khi đọc lại mã và nâng cao hiệu suất làm việc nhóm.

II. Các Quy Tắc Cơ Bản Trong Coding Convention

1. Quy Tắc Đặt Tên

Cách đặt tên biến và hàm có ảnh hưởng lớn đến khả năng đọc hiểu code. Những tên biến không có ý nghĩa như a, b, c sẽ gây khó khăn trong việc quản lý và bảo trì mã. Một số quy tắc đặt tên phổ biến bao gồm:

• camelCase: Viết thường chữ cái đầu tiên của từ đầu tiên, viết hoa các ký tự đầu của các từ còn lại. Thường dùng cho tên hàm và tên biến. Ví dụ: firstName, lastName.
• PascalCase: Viết hoa chữ cái đầu tiên của tất cả các từ, thường áp dụng cho tên class. Ví dụ: MickeyMouse, FirstName.
• snake_case: Tất cả chữ cái viết thường, phân tách bằng dấu _. Thường dùng cho tên hằng số. Ví dụ: program_final, get_max().

Một số quy tắc cụ thể khi đặt tên:

• Tên biến và hàm phải có ý nghĩa, rõ ràng chức năng (VD: authorName, GetAllBooks()).
• Tên class sử dụng danh từ (VD: class Author, var bookTitle).
• Tên hàm sử dụng động từ (VD: SaveBook(), DeleteAuthor()).

2. Quy Tắc Về Số Lượng

• Một dòng code không nên dài quá 80 ký tự.
• Một câu lệnh không nên lồng quá 4 cấp.
• Một hàm không nên có quá 5 tham số.
• Một hàm không nên dài quá 30 dòng.
• Một class không nên dài quá 500 dòng.
• Mỗi hàm chỉ nên làm một việc duy nhất và tên hàm nên phản ánh rõ chức năng đó (VD: SaveAndPublishArticle()).

3. Quy Tắc Xuống Dòng

3.1. Đối với hàm có nhiều cấp lồng:

Nên xuống dòng để tăng độ dễ đọc:

public void PrintBookTitles(List<String> titles) {
    titles.forEach(item -> {
        if (!item.IsNullOrEmpty()) {
            Console.WriteLine(item.ToUpperCase());
        }
    });
}

3.2. Các đoạn code cùng cấp nên thẳng hàng với nhau:

public void SendEmail(
    string recipient, 
    string subject, 
    string body, 
    bool isImportant)
{
    // Code here
}

3.3. Xuống dòng trước các toán tử:

int result = a 
    + b
    + c * d
    / e
    - f;

4. Quy Tắc Comment

• Hạn chế sử dụng comment cho những đoạn code đơn giản và rõ ràng.
• Nên xóa mã code không sử dụng, không nên comment out.
• Comment nên được sử dụng để làm rõ ý nghĩa, đặc biệt cho logic phức tạp và để cảnh báo khi có nguy cơ hoặc hậu quả.

III. Kết Luận

Việc tuân thủ các quy tắc Coding Convention đóng vai trò then chốt trong việc viết mã sạch, dễ hiểu và dễ bảo trì. Điều này không chỉ cải thiện chất lượng phần mềm mà còn nâng cao hiệu suất làm việc của cả nhóm.

Hy vọng bài viết này đã giúp bạn hiểu rõ hơn về coding convention và các quy tắc quan trọng liên quan. Cảm ơn bạn đã đọc và hẹn gặp lại!
source: viblo