Code Convention Là Gì? Các Quy Tắc Chung Khi Viết 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ậy lý do các developer cần sử dụng coding convention là gì? Có từ 40 đến 80% chi phí của một dự án phần mềm là dành cho việc bảo trì, và việc tuân theo những tiêu chuẩn nhất định giúp code dễ đọc hơn, từ đó quá trình bảo trì và quản lý code cũng được thực hiện nhanh chóng và dễ dàng hơn.

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)

Với cú pháp lạc đà, từ đầu tiên của cụm thường sẽ được viết thường. Sau đó, ký tự đầu của các từ đứng sau sẽ được viết in hoa. Cú pháp lạc đà này thường sẽ được áp dụng cho những phương thức, hàm hay các tên biến.

• 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)

Cú pháp con rắn này quy định tất cả những chữ cái đều phải được viết thường. Ngoài ra cần phải sử dụng thêm dấu gạch dưới “_” để phân tách những từ với nhau. Tuy nhiên, đối với một vài ngôn ngữ hay một số các trường hợp nhất định, tất cả những chữ cái có thể đều đượ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, MAX_SELECT, product_name, final_final1_final2…

Cú pháp Pascal (PascalCase)

Khi áp dụng cú pháp Pascal, toàn bộ những ký tự đầu của mỗi từ trong một cụm đều sẽ được viết in hoa. Cú pháp này thường sẽ được dùng cho tên class hoặc đôi khi bao gồm cả các tên biến. Ví dụ: class My class, 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 biến, đặt tên file, đặt tên cho hằng số…. Đây chính là một yếu tố giúp cho người khác có thể hiểu dòng code mà bạn viết ra. Hiện nay, có 3 quy tắc đặt tên phổ biến được nhiều người dùng nhất đó là: camelCase, snake_case và PascalCase.

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

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

Quy tắc số lượng

Quy tắc về số lượng khi viết code được đề cập đến trong bộ quy tắc của Oracle. Cuốn Refactoring in Large Software Projects: Performing Complex Restructurings Successfully sáng tác bởi tác giả Martin Lippert.

Chi tiết được quy định như sau: không viết quá 500 dòng đối với mỗi lệnh Class, viết tối đa 30 dòng cho một hàm. Bên cạnh đó, trong một hàm nên để tối đa 5 tham số. Với mỗi câu lệnh được viết ra nên sử dụng tối đa là 4 cấp và viết 80 ký tự cho một dòng code thường.

Quy tắc bình luận

Ta không nên giải thích code bằng comment mà chỉ nên áp dụng các quy tắc đặt tên khi viết code nhằm giúp chúng trở nên dễ hiểu hơn. Nếu bạn là một người vừa mới làm quen với lập trình, bạn có thể dùng tính năng bình luận để giải thích cho những đoạn code quá phức tạp.

Lưu ý rằng comment chỉ nên để giải thích tại sao chứ không nên mang tính chỉ dẫn cách làm như thế nào. Bên cạnh đó, bạn chỉ nên bình luận sau khi hoàn tất một đoạn code nào đó. Không nên viết xong hết toàn bộ code rồi mới bình luận.

Quy tắc xuống dòng

Bộ quy tắc của Oracle quy định quy tắc xuống dòng như sau: với một hàm nhiều cấp thì ta nên xuống dòng đối với từng cấp một, ta nên viết những đoạn code cùng một cấp ở trên cùng một cột. Khi xuống dòng, ta nên bắt đầu cùng cấp với những dòng phía trên và ta sẽ xuống dòng trước những toán tử như *, -, ?, +…

bởiTerus Technique

Cập nhật lúc 3 Tháng 3, 2025

CHIA SẺ