Code convention là gì? Một số quy tắc “vàng” khi viết code convention

Coding convention là thuật ngữ mà bất kể các lập trình viên nào cũng đã từng nghe đến. Trên thực tế thì việc tuân thủ theo coding convention hay không có ảnh hưởng đến các kết quả của công việc là một điều khó. Vậy coding convention là gì? Hãy cùng thiendia3d tìm hiểu ngay trong bài viết dưới đây.

Code convention là gì? Tìm hiểu về Java Code Convention Python

Code convention là gì là gì? Coding convention là tập hợp những quy tắc chung đối với các lập trình nhằm giúp đạt được việc code dễ đọc, dễ hiểu, qua đó giúp cho việc quản lý dễ dàng và bảo trì một cách nhanh chóng, thuận tiện hơn. Hiểu đơn giản nó là những quy ước coding, những quy ước về phong cách code, cách đặt tên biến, tên file, tên hàm, …để các lập trình viên tuân theo.

Nó giúp ích cho bạn rất nhiều trong khi làm việc nhóm, cũng như khi làm việc với hệ thống lớn, được thiết kế cũng như bảo trì các giai đoạn với các nguồn nhân lực khác nhau thì việc tuân thủ coding convention là rất quan trọng giúp cho lập trình viên đọc code dễ dàng cũng như tiết kiệm được thời gian khi đọc java Code Convention Python có những quy ước đặt tên rõ ràng hơn. Ngoài ra, cũng giúp cho những người code sau trong việc bảo trì và phát triển hệ thống hiệu quả hơn.

Vì sao nên sử dụng Code Convention java?

Sau khi biết được khái niệm Code convention là gì, vậy vì sao nên sử dụng. Khi Code có Convention, hoặc Code theo quy tắc chung mà mọi người đều biết, điều này sẽ giúp cho các hoạt động làm việc theo nhóm dễ dàng hơn. Trừ một vào trường hợp đặc biệt, bình thường, một dự án phần mềm không thể được hoàn thiện chỉ với một cá nhân mà cần phải làm việc theo nhóm. Nếu mỗi người viết một phong cách khác nhau thì những người sau sẽ “gai mắt” hoặc không hiểu bạn đang viết gì.

Do đó, việc Code theo một quy ước chung sẽ giúp làm việc theo nhóm có hiệu quả hơn, hiểu nhau hơn và giảm thiểu được tình trạng đặt ra những câu hỏi như: “Bạn viết cái gì vậy!” “Cái này là cái gì vậy bạn hiền?”,…

Khi Code Convention java sẽ có những lợi ích sau:

• Làm việc nhóm có hiệu quả hơn

• Thống nhất và tuân thủ theo một tiêu chuẩn nhất định

• Giúp người khác nắm bắt Code mà bạn viết nhanh hơn

• Dễ dàng nâng cấp và cải tiến phần mềm

• Có thể tái sử dụng trong các phần mềm khác

• Thuận lợi hơn trong việc phát triển và bảo trì hệ thống sau này

Những cú pháp thông dụng của Code convention là gì?

Để hiểu hơn về Code convention là gì. Việc nắm rõ thông dụng của convention code là một điều rất cần thiết.

Cú pháp lạc đà

Cú pháp lạc đà (CamelCase), còn được gọi là PascalCase, là một quy tắc đặt tên phổ biến trong lập trình, được sử dụng để đặt tên cho các biến, hàm, lớp, v.v. Theo quy tắc này, chữ cái đầu tiên của mỗi từ trong tên sẽ được viết hoa, ngoại trừ chữ cái đầu tiên.

Ví dụ: firstName, lastName.

Cú pháp Pascal

Cú pháp Pascal là một quy tắc đặt tên được sử dụng phổ biến trong lập trình, đặc biệt là trong ngôn ngữ Pascal. Theo quy tắc này, tên sẽ bắt đầu bằng một chữ cái viết hoa, sau đó tất cả các chữ cái tiếp theo trong từ đầu tiên và các từ tiếp theo đều viết thường.

Ví dụ:

• myVariable

• getUserInput

• EmployeeDetails

Cú pháp con rắn

Cú pháp con rắn (snake_case) là một quy tắc đặt tên phổ biến trong lập trình, được sử dụng để đặt tên cho biến, hàm, lớp, v.v. Theo quy tắc này, tất cả các chữ cái trong tên đều viết thường và được nối với nhau bằng dấu gạch dưới (_).

Ví dụ:

• my_variable_name

• get_user_input

• employee_details

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

Bên cạnh Code convention là gì thì quy tắc sử dụng cũng rất hết sức quan trọng. Dưới đây là các quy tắc mà bạn cần chú ý khi viết convention code.

Naming Convention – quy tắc đặt tên

Một trong những việc giúp người khác có thể hiểu Code của bạn viết gì là thông qua: cách đặt tên các biến, hằng, class,…được gọi chung là định danh.

Khi thực hiện một bài tập nhỏ lúc bạn học tin học cấp 3 hoặc những bài tập giải thuật đơn giản, chúng ta được chỉ cách đặt tên biến là a, b, c, d. Tuy nhiên, điều này chỉ áp dụng đối với những bài tập cấp thấp và không có nhiều chức năng.

Chúng ta có một số cách đặt tên phổ biến như:

• Cú pháp lạc đà – camelCase

• Cú pháp Pascal – PascalCase

• Cú pháp con rắn – snake_case

Tùy theo ngôn ngữ sẽ có những cách sử dụng cú pháp riêng, tuy nhiên bạn có thể tham khảo ví dụ để hiểu rõ hơn.

Trong phần lớn các công ty phần mềm trong nước hay ngoài nước, quy tắc đặt định danh được mặc định là sử dụng tiếng Anh.

Quy tắc số lượng

Một số quy tắc số lượng trong cuốn sách Clean Code A Handbook of Agile Software Craftsmanship của Robert C. Martin, quyển Refactoring in Large Software Projects: Performing Complex Restructurings Successfully của Martin Lippert cũng như bộ quy tắc của Oracle có ghi như sau:

• Một dòng Code không dài quá 80 ký tự

• Một câu lệnh nên lồng tối đa khoảng 4 cấp

• Một hàm không nên chứa vượt quá 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 quá 500 dòng

• …

Quy tắc comment – bình luận

• Bạn cần tránh sử dụng comment để giải thích Code, việc hoàn thiện đoạn Code bằng như quy tắc đặt tên sẽ giúp Code của bạn trở nên dễ hiểu hơn.

• Nếu bạn là người mới hoặc nhanh quên thì việc sử dụng comment để giải thích việc mình làm với đoạn Code cũng là một cách khá hay.

Quy tắc xuống hàng

Theo bộ quy tắc của Oracle thì chúng ta sẽ có:

• Nếu một hàm có nhiều cấp lồng nhau thì mỗi cấp chúng ta nên xuống dòng.

• Các đoạn Code bằng cấp 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 toán tử ví dụ như: +, -, *, ?,…

Trên đây Thiendia3d đã giải thích Code convention là gì? Hy vọng với những thông tin này sẽ các bạn làm việc có hiệu quả hơn. Đừng quên theo dõi chúng tôi để có thêm nhiều kiến thức mới! Chúc bạn thành công!q