Code convention là gì? Tại sao nên sử dụng code convention?

Nếu muốn trở thành lập trình viên chuyên nghiệp thì Code convention chính là hoạt động mà bạn nắm rõ. Nhưng viết code ra sao thì lập trình viên phải dựa vào nhiều tiêu chí và điều kiện khác nhau, bên cạnh định dạng của code thì bạn còn phải viết code tuân theo tất cả các quy định về loại ngôn ngữ mà bạn sử dụng. Để hiểu rõ hơn về vấn đề trên, hãy cùng chúng tôi tìm hiểu về Code convention là gì? Các quy tắc viết code trong bài viết dưới đây nhé!

Code convention là gì? 

Là người mới bắt đầu học lập trình viên hoặc bạn đang có định hướng theo lĩnh vực này thì chắc hẳn Code convention chính là thuật ngữ đầu tiên bạn được nghe nói tới. Vậy Code convention là gì? Chúng có ý nghĩa ra sao?

Bạn có thể hiểu một cách đơn giản thì Code convention chính là quy ước viết code. Nó được bao hàm bởi 1 nhóm các quy ước, quy tắc được sử dụng để viết code. 

Trong đó, Code convention bao gồm các quy tắc về số lượng, quy tắc về định danh, các quy tắc để xuống hàng, quy tắc để đặt tên hàm, tên biến, tên file…. Đây là quy tắc mặc định bắt buộc lập trình viên phải tuân theo nếu muốn sản phẩm code của mình sạch, đẹp, được mọi người đánh giá dễ hiểu, dễ nhìn. 

Đây là bộ quy tắc không thể thiếu trong quá trình hoàn thiện dự án lớn về phần mềm, tất cả các thành viên trong dự án phải nắm rõ quy tắc và dựa vào áp dụng quy tắc trên để giao tiếp được và hiểu được ý tưởng của nhau. 

Bên cạnh đó, nếu bạn áp dụng quy tắc trên cho dự án thì quá trình bảo trì hoặc sửa chữa phần mềm cũng diễn ra nhanh chóng và có hiệu quả hơn. 

Đối với mỗi dự án phần mềm, Code convention còn được biểu thị cho các thông tin như:

– Cách để đặt tên cho biến 

– Quy tắc đặt dấu ngoặc 

– Cách sử dụng phím tắt Tab, Space, căn độ rộng của lề, thụt lề..

– Cách để đặt khoảng trắng đối với các biểu thức số học

– Phương pháp viết các tệp câu lệnh 

– Cách tổ chức File 

– Viết code cho tài liệu

Tại sao nên sử dụng code convention

Nguyên nhân khiến cho các developer thường xuyên sử dụng Code convention là gì? 

Có thể bạn chưa biết hiện nay mỗi dự án phần mềm sẽ có tới 40 – 80% chi chí là dành cho việc bảo trì, nâng cấp và tuân theo quy chuẩn thông dụng nếu muốn code “sạch, đẹp” và dễ hiểu. 

Do đó việc sử dụng Code convention sẽ thúc đẩy quá trình trên nhanh và tối ưu hiệu quả nhất. 

Thông thường, trong mỗi dự án phần mềm bạn không thể làm việc cá nhân để hoàn thiện chúng mà cần sự giúp đỡ của cả đội nhóm. Trong đội nhóm thì mỗi thành viên sẽ có cách viết code cá nhân.

Vì thế, khi áp dụng quy tắc viết Code convention mang lại một vài ý nghĩa thiết thực sau:

– Áp dụng chung 1 kiểu làm việc sẽ giúp công việc đạt hiệu quả cao hơn, hoạt động nhanh hơn

– Tạo nên sự gắn kết và đồng bộ dữ liệu cao 

– Mọi người trong đội nhóm sẽ dễ dàng hiểu hơn về sản phẩm code của nhau 

– Quá trình nâng cấp hệ thống hoặc bảo trì sẽ diễn ra nhanh chóng, tiết kiệm thời gian.

– Một quy tắc có thể áp dụng vào nhiều dự án sản phẩm khác nhau 

– Việc tìm lỗi sai trở nên dễ dàng hơn….

– Hạn chế các lỗi về logic hoặc hiệu suất hoạt động của website, phần mềm 

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

Để hiểu hơn về Cú pháp thông dụng của Code convention là gì, thì việc nắm rõ các cú pháp thông dụng của nó sẽ giúp bạn nắm bắt và áp dụng dễ dàng hơn. Cụ thể trong tin dưới đây:

Cú pháp lạc đà (camelCase)

Được thể hiện bằng chữ cái đầu tiên của từ viết thường đầu tiên trong dòng code của bạn, hoặc có thể là chữ đầu tiên trong ký tự viết hoa tiếp theo

Cụ thể như: thisIsTheNameFollowTheCamelCase, firstName ….

Cú pháp Pascal (PascalCase)

Hiểu đơn giản thì cú pháp Pascal chính là chữ cái đầu tiên viết hoa trong mỗi từ 

Như: ProductPrice, ProductName

Cú pháp con rắn (snake_case)

Nếu bạn là lập trình viên chuyên nghiệp thì đây là cú pháp đơn giản và thường gặp nhất trong mỗi dòng code. Tất cả dòng code dưới cú pháp này đều được viết bằng chữ cái thường và mỗi từ sẽ được cách nhau bởi 1 dấu gạch dưới.

Ví dụ cụ thể: product_name, this_is_the_name_follow_the _snake

Một vài quy tắc phổ biến khác có thể kể tới như: 

– Tên biến thường là cụm từ chỉ tính từ, danh từ như UserName, UserMode….

– Hàm trong Code convention thường được viết với động từ đứng trước như getUserName, increaseDownloadCounter….

– Không được viết tên đứng một mình vì khi này chúng không có nghĩa như fName, uUser, a, b1….

– Hằng số viết theo mẫu UPPER_CASE ví dụ CLICK_COUNTER

4 quy tắc code convention

Quy tắc đặt tên (Naming Convention)

Cách đặt tên file, đặt tên biến, tên cho hằng số…. đây chính là yếu tố giúp cho người khác có thể hiểu được dòng Code bạn viết ra. Hiện nay có 3 quy tắc đặt tên thông dụng được nhiều người sử dụng nhất là camelCase, PascalCase và snake-case. Bên cạnh việc đặt tên cho đúng cú pháp thì bạn nên lưu ý 1 vài vấn đề nhỏ sau đây:

– Danh từ thường được sử dụng để viết tên biến và tên class thường 

– Người ta thường đặt động từ ở trước tên hàm 

– Nên thể hiện rõ chức năng trong mỗi tên gọi của code 

– Khi viết code điều tối kỵ nhất là viết tắt vì khi viết tắt mọi người sẽ khó có thể hiểu được ý nghĩa, nội dung mà bạn muốn truyền đạt 

– Hạn chế đặt tên không có nghĩa cho file code

Quy tắc số lượng

Quy tắc số lượng được hoạt động dựa trên nguyên tắc Oracle. Chi tiết được quy định như sau: 

– Không viết dài hơn 500 dòng đối với mỗi lệnh Class

– Tối đa 30 dòng cho 1 hàm 

– Trong một hàm nên để tối đa là 5 tham số

– Với mỗi câu lệnh viết ra nên sử dụng tối đa 4 cấp 

– Viết 80 ký tự cho 1 dòng code thường 

Quy tắc xuống dòng

Cũng dựa theo bộ quy tắc Oracle với các quy định:

– Nếu bạn đang viết hàm với nhiều cấp thì nên viết mối cấp là 1 dòng 

– Nội dung trong 1 cột thể hiện cho nhóm code có cùng 1 cấp

– Trước mỗi thuật toán tử bạn nên xuống dòng như +, -, *, ?….

Quy tắc Comment 

– Để thích code hoặc ghi chú trong dự án thì bạn không nên dùng quy tắc comment để biểu thị mà nên sử dụng quy tắc đặt tên. Từ đó thành viên khác trong nhóm mới có thể hiểu được những gì bạn đang trình bày 

– Bạn chỉ nên sử dụng quy tắc Comment để ghi chú hoặc giải thích cho code nếu như bạn mới tìm hiểu hoặc làm quen với lĩnh vực này.

– Không nên hướng dẫn cách làm ra sao mà bạn hãy giải thích các lỗi sai đó trước

– Sau mỗi đoạn code đã hoàn thành nên để lại Comment, hạn chế trường hợp viết xong cả dự án code rồi mới để lại Comment.

Như vậy, bài viết trên chúng tôi đã giải thích cho bạn Code convention là gì, các cú pháp và quy tắc viết Code convention thông dụng nhất hiện nay. Mong rằng những thông tin trên là hữu ích đến bạn, đặc biệt là người mới tìm hiểu về Code convention. Cảm ơn bạn đã đón đọc, đừng quên theo dõi Đào tạo Tester để cập nhật thêm nhiều thông tin mới hơn nữa nhé!