Là một lập trình viên, bạn đã quen thuộc với thuật ngữ Code Convention. Nhưng bạn đã hiểu rõ Code Convention là gì và quy tắc viết code ra sao chưa? Hãy cùng Trường Trung Cấp Việt Hàn (VKI) khám phá ngay trong bài viết dưới đây nhé.
1. Tìm hiểu về Code Convention
Bạn có thể hiểu Code Convention đơn giản là “Quy ước viết Code”. Đây là một tập hợp các quy ước về cách viết code, đặt tên biến, class, hàm, file, và các quy tắc khác như thụt đầu dòng, comment, cách sử dụng dấu chấm, dấu phẩy để làm cho code trở nên đẹp mắt, dễ nhìn và dễ hiểu hơn.
Việc áp dụng Code Convention giúp việc giao tiếp giữa các thành viên trong một dự án phần mềm lớn trở nên dễ dàng hơn khi mọi người tuân thủ cùng một quy tắc viết code. Đồng thời, việc phát triển và bảo trì hệ thống cũng trở nên dễ dàng hơn khi sử dụng các module chức năng có thể tái sử dụng.
2. Lợi ích của việc sử dụng Code Convention
Việc tuân thủ Code Convention mang lại nhiều lợi ích cụ thể như:
- Giúp làm việc một cách thống nhất và tuân thủ theo quy chuẩn.
- Dễ dàng cải tiến hoặc nâng cấp phần mềm.
- Quy tắc viết code có thể tái sử dụng với đa dạng các phần mềm khác.
- Hiệu quả trong quá trình làm việc nhóm.
- Tiết kiệm thời gian và thuận lợi trong việc phát triển và bảo trì hệ thống.
3. Những quy tắc chung của Code Convention
Sau khi đã hiểu rõ định nghĩa về Code Convention là gì, chúng ta hãy cùng Trường Trung Cấp Việt Hàn (VKI) tìm hiểu những quy tắc chung khi viết code.
Quy tắc về số lượng
- Một hàm không quá 30 dòng.
- Mỗi class không nên vượt quá 500 dòng.
- Nên lồng tối đa 4 cấp trong một câu lệnh.
- Không nên chứa quá 5 tham số trong một hàm.
- Dòng code không nên dài quá 80 ký tự.
Quy tắc đặt tên – Naming Convention
Cách đặt tên biến, hằng số, class,… có thể làm cho code dễ hiểu. Có những phong cách đặt tên phổ biến như:
- Cú pháp lạc đà – camelCase: viết thường từ đầu tiên, viết hoa từ tiếp theo. Ví dụ: firstName, lastName, runLow(), getOnTop()…
- Cú pháp con rắn – snakecase: viết thường các từ và ngăn cách bởi dấu ““. Ví dụ: final_final1_final2…
- Cú pháp Pascal – PascalCase: viết hoa chữ cái đầu tiên của từ. Thường được sử dụng cho tên class. Ví dụ: class Mice, class MickeyMouse…
Bên cạnh đó, khi đặt tên cần lưu ý sử dụng danh từ đối với tên class hay biến, động từ thường được dùng cho tên hàm và đặt tên gắn với chức năng để code trở nên rõ ràng.
Quy tắc xuống hàng
Khi viết code, chúng ta cần tuân thủ những quy tắc xuống hàng sau:
- Xuống dòng khi một hàm có quá nhiều cấp lồng.
- Dòng xuống hàng phải cùng cấp với dòng phía trên và các đoạn code cùng cấp nên ở cùng một cột.
- Xuống hàng trước các toán tử như +, -, *, ?…
Quy tắc bình luận – comment
Việc hoàn thiện code theo quy tắc giúp việc hiểu code trở nên dễ dàng hơn mà không cần phải giải thích qua bình luận.
4. Câu hỏi thường gặp về Code Convention
Không tuân thủ quy tắc viết code có được không?
Chương trình của bạn vẫn có thể chạy được nhưng bạn sẽ gặp khó khăn trong việc nhớ code của bạn đã viết. Tuân thủ quy tắc giúp việc đọc và hiểu code dễ dàng hơn.
Tìm hiểu Code Convention ở đâu?
Bạn có thể tìm hiểu Code Convention trên Google hoặc Bing để tìm kiếm tất cả những thông tin liên quan đến quy tắc viết code.
5. Lời kết
Qua bài viết trên đây, bạn đã hiểu rõ về Code Convention là gì và những quy tắc chung khi viết code. Hy vọng rằng những kiến thức này sẽ giúp ích cho bạn trong quá trình viết code và lập trình phần mềm. Hãy tiếp tục theo dõi Trường Trung Cấp Việt Hàn (VKI) để có thêm nhiều thông tin hữu ích khác.
