Code Convention La Gi? Cac Quy Tac Chung Khi Viet Code

Chất lượng của code có thể được cân nhắc dựa trên nhiều khía cạnh và tiêu chí khác nhau, không chỉ định dạng mà các lập trình viên còn phải tuân theo những quy ước nhất định tùy theo từng ngôn ngữ lập trình và nền tảng. Vậy code convention là gì? Cũng như một số quy tắc chung khi viết code cho mọi ngôn ngữ lập trình như thế nào? Tất cả sẽ được giải đáp trong bài viết dưới đây của Terus.

I. Code Convention là gì?

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.

Tiêu chuẩn viết code (coding standard) thường được công nhận và sử dụng bởi một nhóm các developer để chia sẻ code một cách thống nhất. Một ví dụ phổ biến của coding standard là tập hợp các quy ước được áp dụng trong các tài liệu của một ngôn ngữ lập trình. Lấy ví dụ tiêu biểu như ngôn ngữ C có tiêu chuẩn K&R, tiêu chuẩn của Microsoft về C# hay tiêu chuẩn cho Java của Oracle,…

Thông thường, một code convention sẽ mô tả các thông tin sau:

• Cách đặt tên biến (camel case: variableName, snake case: variable_name,…).

• Kiểu thụt lề, độ rộng thụt lề, sử dụng tab hay space,…

• Phương pháp đặt dấu ngoặc.

• Cách dùng khoảng trắng trong các biểu thức logic và số học.

• Cách viết comment cho code và tài liệu.

• Quy ước đặt tên class, tên file.

• Cách viết câu lệnh.

• Cách khai báo class và giao diện.

• Phương pháp tổ chức file.

II. Tại sao nên sử dụng Code Convention?

Vì lý do gì mà các developer phải sử dụng coding convention? Việc bảo trì của một dự án phần mềm chiếm từ bốn mươi đến tám mươi phần trăm chi phí của dự án. Quá trình bảo trì và quản lý code được thực hiện nhanh chóng và dễ dàng hơn khi tuân thủ các tiêu chuẩn nhất định.

Những lợi ích mà Coding Convention mang lại:

• Đẩy cao năng suất làm việc nhóm nhanh hơn.

• Quy tắc hoạt động của Code Convention theo tính thống nhất và tuân thủ theo tiêu chuẩn sẽ giúp bạn dễ dàng làm việc hơn.

• Khi viết Code bằng Code Convention, sẽ khiến người khác dễ hiểu và nắm bắt được cái mà bạn truyền tải đến.

• Phần mềm Code Convention dễ dàng nâng cấp và được cải tiến.

• Code Convention có thể tái sử dụng trong nhiều phần mềm và các ứng dụng khác.

• Việc bảo trì hệ thống với Code Convention trở nên thuận lợi và dễ dàng hơn bao giờ hết.

Bên cạnh đó, việc thống nhất code sẽ giảm thiểu tối đa các lỗi liên quan đến logic hay bảo mật, đôi khi còn có thể giúp đảm bảo hiệu năng của phần mềm và website.

III. Các cú pháp thông dụng của code convention

Để hiểu rõ hơn về những cú pháp của Code Convention là gì. Việc nắm rõ những cú pháp thông dụng của nó sẽ giúp cho bạn nắm bắt cũng như áp dụng một cách dễ dàng hơn.

Cú pháp lạc đà (camelCase)

Từ đầu tiên của cụm thường sẽ được viết thường khi sử dụng cú pháp lạc đà. Tiếp theo, các ký tự đầu của các từ đứng sau sẽ được viết in hoa. Các phương thức, hàm và tên biến thường được sử dụng cú pháp lạc đà này.

• Ví dụ về hàm hay phương thức: rumLow(), get On Top(), firstName, lastName…

• Ví dụ về biến: float spaceX…

Cú pháp con rắn (snake_case)

Tất cả các chữ cái phải được viết thường theo cú pháp con rắn này. Ngoài ra, các từ phải được phân biệt với nhau bằng dấu gạch dưới "_". Nhưng đối với một số ngôn ngữ hoặc trong một số trường hợp nhất định, tất cả các chữ cái có thể được viết in hoa toàn bộ.

Cú pháp con rắn khá phổ biến trong việc đặt tên hằng. Đôi khi việc đặt tên cho các chương trình cũng sử dụng cú pháp con rắn này. Ví dụ: this_is_the_name_follow_the snake, MAXSELECT, product_name, final_final1_final2…

Cú pháp Pascal (PascalCase)

Toàn bộ những ký tự đầu của mỗi từ trong một cụm sẽ được viết in hoa khi sử dụng cú pháp Pascal. Tên class và đôi khi cả tên biến đều có thể được sử dụng cú pháp này. Một ví dụ là lớp học của tôi, Mickey Mouse...

IV. Tổng hợp những quy tắc chung khi viết Code

Quy tắc đặt tên (Naming Convention)

Cách đặt tên cho hằng số, biến và file Đây là một phần quan trọng để giúp người khác hiểu dòng code mà bạn viết ra. Hiện tại, ba quy tắc đặt tên phổ biến nhất là camelCase, snake_case và PascalCase.

Bạn cần lưu ý một số vấn đề nhỏ sau đây, ngoài việc đặt tên sao cho đúng cú pháp: danh từ thường được sử dụng để viết tên tên class thường và biến, và ta thường đặt động từ ở phía trước tên hàm.

Mỗi tên gọi của code phải mô tả rõ ràng từng chức năng của nó, và việc đặt tên cho file code phải được hạn chế. Ngoài ra, hãy tránh viết tắt khi viết code. Khi viết tắt, người đọc sẽ khó hiểu và hiểu nội dung hay ý nghĩa bạn muốn truyền đạt.

Quy tắc số lượng

Bộ quy tắc của Oracle bao gồm quy tắc về số lượng khi viết code. Tác giả Martin Lippert đã viết cuốn sách Refactoring in Large Software Projects: Performing Complex Restructurings.

Đối với mỗi lệnh Class, không viết quá 500 dòng và không viết quá 30 dòng cho một hàm. Ngoài ra, có thể có tối đa năm tham số trong một hàm. Một dòng code thông thường nên có tối đa bốn cấp và tám mươi ký tự cho mỗi câu lệnh.

Quy tắc bình luận

Nhằm làm cho code trở nên dễ hiểu hơn, chúng ta chỉ nên sử dụng các quy tắc đặt tên khi viết code thay vì đưa ra các bình luận giải thích. Tính năng bình luận có thể giúp bạn giải thích những đoạn code quá phức tạp nếu bạn mới học lập trình.

Lưu ý rằng các bình luận không nên bao gồm lời giải thích hoặc hướng dẫn cách làm. Ngoài ra, bạn chỉ nên để lại bình luận sau khi hoàn thành một đoạn code. Không nên đưa ra bình luận trước khi viết xong toàn bộ code.

Quy tắc xuống dòng

Quy tắc xuống dòng được bộ quy tắc của Oracle quy định như sau: khi có một hàm nhiều cấp, chúng ta nên viết những đoạn code cùng một cấp trên cùng một cột thay vì xuống dòng cho mỗi cấp. Khi xuống dòng, chúng ta nên bắt đầu cùng cấp với những dòng phía trên và xuống dòng trước các toán tử như *, -,? và +...

FAQ - Giải đáp thắc mắc liên quan đến code convention

1. Convention trong code là gì?

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.

2. Có thể viết code mà không cần đến Code Convention không?

Câu trả lời là có, ta chỉ cần viết code chính xác thì phần mềm vẫn có thể hoạt động bình thường. Tuy nhiên khi cần được bảo trì, nâng cấp hay tìm và sửa lỗi sai thì bạn sẽ gặp phải rất nhiều khó khăn.