Lập trình, việc viết mã nguồn, thường phức tạp và bao gồm nhiều yếu tố khác nhau. Để làm cho mã nguồn trở nên dễ đọc và hiểu hơn, nó cần tuân thủ các quy tắc chung. Đó chính là lý do tại sao chúng ta có các “Quy tắc viết mã” (Code Convention). Hãy cùng blog khám phá chi tiết hơn về Code Convention qua bài viết dưới đây!
Code Convention là gì?
Code Convention (Coding Standards) là một bộ quy tắc được áp dụng khi viết mã nguồn, nhằm làm cho code trở nên dễ đọc, hiểu và duy trì. Code Convention bao gồm các quy tắc về định dạng, quy tắc đặt tên, quy tắc về số lượng, và nhiều quy tắc khác.
Việc tuân thủ Code Convention rất quan trọng đặc biệt khi làm việc trên các dự án phức tạp với nhiều lập trình viên. Các quy tắc này giúp tạo sự đồng nhất trong việc viết code, giúp các thành viên trong nhóm dễ dàng trao đổi thông tin và hiểu mã nguồn của nhau. Nó cũng giúp tăng tốc quá trình phát triển phần mềm, bảo trì hệ thống, và tích hợp các tính năng mới một cách hiệu quả hơn.
Ưu điểm của Code Convention
Sau khi đã hiểu về Code Convention là gì, có thể bạn đang tự hỏi tại sao cần phải tuân thủ Code Convention. Thực tế, để hoàn thành một dự án phần mềm, đòi hỏi sự cộng tác từ nhiều người, chứ không phải chỉ là công việc của một cá nhân (ngoại trừ trường hợp đặc biệt).
Nếu mỗi thành viên trong nhóm viết code theo phong cách riêng, việc đọc và hiểu code của đồng nghiệp trở nên khó khăn. Điều này dẫn đến việc lặp đi lặp lại các câu hỏi như “Phần này làm gì vậy?” hoặc “Bạn có thể giải thích đoạn này không?”.
Việc áp dụng Code Convention mang lại nhiều lợi ích, bao gồm:
1. **Đồng nhất hóa:** Code Convention đảm bảo rằng tất cả thành viên sử dụng cùng một kiểu viết code. Điều này giúp làm việc hiệu quả hơn và nhanh chóng hơn, đồng thời tạo sự đồng bộ và gắn kết trong dự án.
2. **Nâng cấp và bảo trì:** Quá trình nâng cấp hệ thống và việc bảo trì diễn ra suôn sẻ và nhanh chóng, giúp tiết kiệm thời gian đáng kể.
3. **Hiểu code dễ dàng hơn:** Mọi người trong nhóm dễ dàng hiểu code của đồng nghiệp hơn, và việc tìm kiếm lỗi sai trở nên dễ dàng hơn.
4. **Hạn chế lỗi:** Code Convention giúp hạn chế lỗi liên quan đến logic và hiệu suất của phần mềm hoặc website.
Vì vậy, tuân thủ Code Convention là một phần quan trọng để đảm bảo dự án phần mềm diễn ra một cách hiệu quả và dễ quản lý.
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: int i, float spaceX…
Cú pháp con rắn (snake_case)
Cú pháp con rắn (snake_case) yêu cầu viết thường toàn bộ các chữ cái và sử dụng dấu gạch dưới (“_”) để phân tách các từ. Tuy nhiên, có một số trường hợp hoặc ngôn ngữ cụ thể mà cho phép viết in hoa toàn bộ các chữ cái. Cú pháp con rắn thường được sử dụng rộng rãi cho việc đặt tên hằng số. Thậm chí, trong một số tình huống, cú pháp này cũng áp dụng cho việc đặt tên các chương trình.
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…
Tổng hợp các quy tắc chung khi viết Code Convention
Quy tắc đặt tên (Naming Convention)
Cách bạn đặt tên biến, tên file và hằng số có ảnh hưởng lớn đến khả năng người khác đọc và hiểu code của bạn. Hiện nay, có 3 quy tắc đặt tên phổ biến được sử dụng nhiều nhất, bao gồm camelCase, snake_case và PascalCase.
Ngoài việc tuân theo quy tắc đặt tên, có một số nguyên tắc cụ thể mà bạn nên tuân theo:
– Sử dụng danh từ cho việc đặt tên của class và biến. Thường, bạn nên đặt động từ ở phía trước tên của hàm.
– Hãy cố gắng thể hiện rõ ràng mục đích và chức năng của biến, hàm hoặc class trong tên của chúng.
– Tránh việc đặt tên không có ý nghĩa hoặc quá ngắn gọn cho các đoạn code. Hãy chắc chắn rằng tên của bạn phản ánh đúng nội dung hoặc ý nghĩa của code.
– Hạn chế việc viết tắt trong các tên. Viết tắt có thể gây hiểu nhầm và làm giảm khả năng người khác hiểu code của bạn.
Bằng cách tuân theo các nguyên tắc này, bạn có thể làm cho code của mình dễ đọc và dễ hiểu hơn cho người khác.
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ư *, -, ?, +…
Các câu hỏi thường gặp về Code Convention
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.
Nên tìm hiểu thêm về quy tắc viết code ở đâu?
Nếu muốn tìm hiểu thêm về những quy tắc viết code, bạn có thể lên Bing hay Google và tìm kiếm từ khóa: Coding Convention hoặc Code Convention. Kết quả trả về sẽ là những bài đọc về tiếng Anh, bạn có thể dịch tự động sang tiếng việt trên trình duyệt web.
Coding Convention C# là gì?
Coding Convention trong C# là một tập hợp các quy ước và quy tắc về cách viết mã nguồn. Điều này bao gồm cách đặt tên biến, quy ước về viết hoa (như Pascal Case, Uppercase, Camelcase), và cách tổ chức các tệp và thư mục trong một dự án C#. Nó cũng bao gồm cách đặt tên cho các phần khác nhau của mã, như Class, Namespace, Interface, Enumeration, và Attribute.
Với thông tin được trình bày trong bài viết, bạn hi vọng sẽ có cái nhìn tổng quan hơn về Code Convention là gì. Điều này sẽ hữu ích cho bạn khi viết mã và phát triển phần mềm, giúp làm cho mã nguồn dễ đọc và dễ bảo trì hơn.
