Code Convention là gì? Các cú pháp thông dụng của Code Convention

Việc lập trình – viết code vốn đã rất phức tạp cũng như bao gồm đa thành phần. Vì vậy, chúng cần được xây dựng dựa trên các quy tắc chung để trở nên dễ hiểu và dễ nhìn nhất có thể. Cũng chính vì lý do đó mà Code Convention đã được ra đời. Hãy cùng Mona Media tìm hiểu chi tiết hơn về Code Convention thông qua bài viết dưới đây nhé!

Code Convention là gì?

Code Convention (Coding Standards) được hiểu một cách đơn giản là quy ước viết code. Nói theo một cách dễ hiểu, Code Convention là một nhóm những quy tắc và quy ước chung được áp dụng khi ta viết code. Đó là những quy tắc xuống háng, quy tắc số lượng, quy tắc định danh cho hằng, class, biến… Khi chúng ta xây dựng code theo các quy ước này, các khối code sẽ trở nên dễ nhìn, sạch đẹp và dễ hiểu hơn rất nhiều.

Những quy tắc viết code đóng vai trò cực kỳ quan trọng đối với dự án phát triển các phần mềm lớn và đòi hỏi nhiều lập trình viên. Dựa trên những quy ước chung, những thành viên trong nhóm phát triển sẽ có thể dễ dàng giao tiếp cũng như hiểu được ý tưởng của người khác. Việc thêm những module chức năng vào phần mềm, bảo trì hay phát triển hệ thống cũng được thực hiện một cách nhanh chóng hơn.

Ưu điểm của Code Convention

Sau khi đã hiểu được Code Convention là gì. Chắc hẳn bạn cũng rất băn khoăn rằng tại sao nhất thiết cần phải có Code Convention? Dựa trên thực tế, để có thể hoàn thiện một dự án phần mềm cần có sự cộng tác của rất nhiều người chứ không thể chỉ từ một cá nhân riêng lẻ (trừ các trường hợp đặc biệt).

Chính vì vậy, nếu như phong cách viết code của mỗi người mỗi khác nhau. Những thành viên khác sẽ gặp phải rất nhiều khó khăn khi họ cố gắng đọc để hiểu được những gì đối phương đang viết. Khi đó, sẽ không thể tránh khỏi tình trạng lặp đi lặp lại các câu hỏi như: “Cái này là gì vậy?”, “Bạn có thể giải thích giúp mình chỗ này được không?”…

Vì thế, việc chúng ta áp dụng quy tắc viết Code Convention mang lại rất nhiều ưu điểm như: áp dụng chung một kiểu làm việc, giúp công việc đạt hiệu quả cao và hoạt động nhanh hơn; tạo nên sự đồng bộ và gắn kết dữ liệu cao.

Quá trình nâng cấp hệ thống hay việc bảo trì diễn ra suôn sẻ và nhanh chóng, giúp tiết kiệm một lượng lớn thời gian. Đồng thời, mọi người trong nhóm sẽ dễ dàng hiểu về sản phẩm code của nhau hơn, việc tìm lỗi sai từ đó cũng trở nên khá dễ dàng. Ngoài ra, giúp hạn chế tối đa những lỗi về logic hay hiệu suất hoạt động của phần mềm, website.

Xem thêm: Bạn có muốn tự học lập trình website từ A-Z?

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 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…

Xem thêm: Top 10 ngôn ngữ thông dụng trong lập trình phần mềm bạn nên biết

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 đặ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ư *, -, ?, +…

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# bao gồm các quy ước viết hoa: Pascal Case, Uppercase, Camelcase… Cách tổ chức file trong một dự án: thư mục source code C#, file source code C#… Quy tắc đặt tên cho biến: đặt tên Class, Namespace, Interface, Enumeration, Attribute.

Qua bài viết trên, chắc hẳn bạn đã có một cái nhìn tổng quan hơn về Code Convention là gì. Hy vọng rằng bài viết sẽ giúp ích cho bạn trong quá trình viết code cũng như lập trình phần mềm.