Convention Là Gì

  -  

Chất lượng của code có thể được quan tâm đến dựa trên các khía cạnh và tiêu chuẩn khác nhau, không chỉ là định dạng mà những lập trình viên còn đề nghị tuân theo phần nhiều quy mong nhất định tuỳ theo từng ngôn ngữ lập trình và nền tảng nhất định. Trong nội dung bài viết này, bọn họ sẽ cùng tìm hiểu code convention là gì, cũng như một số quy tắc tầm thường khi viết code mang lại mọi ngữ điệu lập trình.

Bạn đang xem: Convention là gì


Code Convention là gì?

Code convention – tạm bợ dịch là quy ước viết code, có thể được hiểu đơn giản dễ dàng là tập hợp những cơ chế chung khi lập trình như viết tên biến, hàm, file, class, comment,… nhằm giúp cho code dễ đọc, dễ dàng nắm bắt hơn do vậy dễ duy trì và sửa lỗi hơn.

*
*
*
*
*
*

Một số quy tắc phổ biến trong câu hỏi đặt tên:

Đặt tên không mơ hồ, bộc lộ đúng tính năng của định danh.Không cần dùng thương hiệu viết tắt.Tên class cùng tên biến thường áp dụng danh từ.Tên hàm thường được sử dụng động từ.Không nên thực hiện magic number (dùng số trực tiếp trong code) mà nên được sắp xếp tên riêng cho hằng số. Ví dụ:

// ❌if (gender === 0) else if (gender === 1) else // ✅const MALE = 0;const FEMALE = 1;if (gender === MALE) else if (gender === FEMALE) else

Quy tắc về số lượng

Một số phép tắc về số lượng trong cuốn sách Clean Code A Handbook of Agile Software Craftsmanship của Robert C. Martin, quyển Refactoring in Large Software Projects: Performing Complex Restructurings Successfully của Martin Lippert cũng như bộ luật lệ của Oracle có ghi như sau:

Một chiếc Code không nên dài thừa 80 ký tự.Một câu lệnh yêu cầu lồng về tối đa 4 cấp.Một hàm tránh việc chứa thừa 5 tham số.Một hàm không nên quá 30 dòng.Một class tránh việc vượt 500 dòng,…Mỗi hàm nên làm làm nhất một việc, nếu thực hiện hai mục đích khác biệt thì tên hàm nên thể hiện thị rõ điều này. Ví dụ: increaseDonwnloadCounterAndSaveToDatabase.

Xem thêm: " Sewage Là Gì - Sewage Effluent Nghĩa Là Gì Trong Tiếng Việt

Quy tắc xuống hàng

Theo cỗ quy tắc của Oracle:

Nếu một hàm có tương đối nhiều cấp lồng nhau, từng cấp phải xuống dòng.Các đoạn code bằng cấp buộc phải ở và một cột cùng với nhau, cái xuống sản phẩm nên bắt đầu cùng cấp với mẫu phía trên.Xuống mặt hàng trước các toán tử (ví dụ như +, -, *, ?,…).

Xem thêm: Là Gì? Nghĩa Của Từ Go Away Là Gì ? Nghĩa Của Từ Go Away Trong Tiếng Việt

Ví dụ:

someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3)); longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // PREFER longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6;

Quy tắc comment

Hạn chế dùng comment để lý giải code hoặc ghi chú những sự thật hiển nhiên. Ví dụ:/** * Hàm thêm role vào database. */function addRole(role) db.roles.add(role);Không comment khi đóng thẻ/ngoặc:......