Code Convention là gì? Những quy tắc chung khi viết Code

Có phải bạn vẫn còn thắc mắc Code Convention là gì? Code Convention là một cụm từ rất quen thuộc. Vậy hãy cùng Công Ty Quảng Cáo Marketing Online Limoseo tìm hiểu xem Code Convention là gì? cũng như tìm hiểu các vấn đề xung quanh Code Convention, đặc biệt là Những lợi ích mà Coding Convention mang lại.

1. Code Convention là gì?

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à nhiều các 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 thủ theo những quy ước nhất định tuỳ theo từng ngôn ngữ lập trình và nền tảng nhất định. 

Code Convention là gì? Code convention – tạm dịch là quy ước viết code, có thể được hiểu một cách đơn giản là tập hợp những nguyên tắc chung khi lập trình như đặt tên các 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.

Các chuẩn khi viết Code hay còn gọi 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 tiêu chuẩn viết code 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.

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 các khoảng trắng trong biểu thức logic và số học.
• Cách để viết comment cho mã code và tài liệu.
• Quy ước đặt tên cho class, tên file.
• Cách viết các câu lệnh.
• Cách để khai báo class và giao diện.
• Phương pháp để tổ chức file.

2. 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ùng để 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 cho mã 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 thiết thực 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 việc 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 mã 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 có thể dễ dàng nâng cấp và được cải tiến.
• Code Convention có thể được 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 thông qua 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 mã code sẽ giảm thiểu tối đa các lỗi liên quan đến tính 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.

Sau khi bạn đọc đã biết được tầm quan trọng của việc tuân theo các quy tắc khi viết mã code, phần cuối cùng của bài viết sẽ giúp người đọc biết được những quy tắc chung trong code convention là gì.

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

Quy tắc chung để viết clean code:

• Suy nghĩ đơn giản và viết code đơn giản nhất có thể.
• Luôn dọn code sao cho sạch hơn lúc ta nhận nó lần đầu, dù là của mình hay của ai khác.
• Tìm được ra nguyên nhân gốc rễ của vấn đề.

3.1 Quy tắc đặt tên

Cách đặt tên những định danh (bao gồm các biến, hằng số, class,…) cũng có ảnh hưởng không nhỏ đến khả năng đọc hiểu code. Hãy tưởng tượng một phần mềm hết sức khổng lồ như Windows nhưng mỗi hàm số chỉ được đặt tên như a, b, c, function1, function2,… thì chắc chắn việc quản lý và bảo trì code là vô cùng khó khăn. Có ba quy tắc đặt tên phổ biến lần lượt là camelCase, PascalCase và snake_case. Cụ thể:

• Camel case: Từ đầu tiên trọng cụm từ được viết thường, những ký tự còn lại thì viết in hoa, áp dụng cho tên hàm, tên biến và tên phương thức. Ví dụ: firstName, lastName, getName(), findMember(),…
• Pascal case: Viết hoa ký tự đầu tiên của tất cả từ có trong cụm, thường áp dụng cho tên class hay tên biến. Ví dụ: MickeyMouse, FirstName,…
• Snake case: Toàn bộ chữ cái đều viết thường, phân tách nhau bằng dấu “_”, thường dùng cho tên hằng số hoặc tên của chương trình. Ví dụ: program_final, get_max(),…

Một số quy tắc chung trong việc đặt tên:

• Đặt tên không mơ hồ, mô tả đúng chức năng của định danh.
• Không nên dùng cách viết tắt.
• Tên class và tên biến nên sử dụng danh từ.
• Tên hàm thường thì sẽ dùng động từ.
• Không nên dùng magic number (dùng số trực tiếp trong code) mà nên đặt tên riêng cho hằng số. 

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

Một số quy tắc về số lượng trong cuốn sách Clean Code A Handbook of Agile Software Craftsmanship của Robert C. Martin cũng như bộ quy tắc của Oracle có ghi như sau:

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

3.3 Quy tắc xuống hàng

Theo bộ quy tắc của Oracle:

• Nếu một hàm có nhiều cấp lồng nhau, mỗi cấp nên xuống dòng.
• Các đoạn code bằng cấp thì nên ở cùng một cột với nhau, dòng xuống hàng nên bắt đầu cùng cấp với dòng phía trên.
• Xuống hàng trước các dấu toán tử (ví dụ như +, -, *, ?,…).
• Comment làm rõ ý nghĩa của mã code (nếu logic phức tạp).

4. Những câu hỏi thường gặp về Coding Convention

• Không sử dụng Code Convention thì có viết code được không?

Câu trả lời là Có. Lập trình chỉ cần viết code một cách đúng quy tắc thi code vân hoạt động bình thường. Tuy nhiên, trong trường hợp phần mềm cần được nâng cấp, bảo trì hoặc tìm và sửa lỗi sai thì người dùng sẽ gặp nhiều khó khăn hơn là sử dụng Code Convention.

• Viết code không cần theo quy tắc được không?

Câu trả lời là Có. Lập trình viên viết mã code mà không tuân theo quy tắc thụt đầu dòng, khoảng cách nào hay đặt tên thì code đó vẫn chạy bình thường. Có điều, trong khoảng thời gian sau thì có thể bạn sẽ không nhớ bạn đã viết gì. Điều này sẽ gây khó khăn cho bạn đấy nhé!

• Nên tìm hiểu thêm quy tắc viết code ở đâu?

Nếu bạn muốn tìm hiểu thêm về quy tắc viết code, bạn có thể lên các phần mềm tìm kiếm như Google hoặc Bing tìm kiếm từ khóa: Code Convention hoặc Coding Convention. Kết quả trả về sẽ là các bài đọc viết bằng tiếng Anh, do đó bạn có thể dịch tự động về tiếng Việt trên trình duyệt của mình.

• Coding Convention Java nghĩa là gì? Coding Convention trong Java bao gồm:
  • Quy tắc Negative Space (White Space): thụt đầu dòng và dòng trống.
  • Quy tắc ngoặc nhọn và quy tắc ngoặc tròn.
  • Quy tắc bình luận.
  • Quy tắc đặt tên bao gồm quy tắc viết hoa, đặt tên interface, abstract class, class, hàm, biến…
  • Việc sử dụng variables.
  • Sử dụng thư viện…
• Coding Convention C# nghĩa là gì? Coding Convention trong ngôn ngữ lập trình C# bao gồm:
  • Quy tắc viết hoa như: Pascal case, uppercase, camelcase,…
  • Phương thức tổ chức file trong một dự án: thư mục source code C#, File source code c#,…
  • Quy tắc dùng để đặt tên biến như đặt tên: class, namespace, attribute, interface, enumeration,…
• Nên tìm hiểu thêm clean code ở đâu?

Clean code là một mã nguồn “sạch” bao gồm: các thức tổ chức mã nguồn code, cách triển khai mã nguồn sao cho khoa học, dễ hiểu và đồng thời mang lại hiệu suất cao nhất có thể cho các chương trình cụ thể. Clean Code có thể sẽ giúp bạn làm việc với phần mềm trơn tru, nhanh nhạy hơn. Bạn có thể tái sử dụng mã nguồn Code của mình để phục vụ phát triển cho nhiều dự án khác cùng nhiều lợi ích khác.

Như vậy, thông qua bài viết Code Convention là gì? phía trên của Công Ty Quảng Cáo Marketing Online Limoseo đã giải đáp cho bạn đọc về Code Convention và các vấn đề liên quan tới Code Convention. Mong rằng bài viết này của Limoseo sẽ giúp ích cho các bạn.