Code convention là gì? Một số quy tắc chung khi viết code lập trình

Code convention là một thuật ngữ mà bất kể lập trình viên nào cũng từng nghe đến và áp dụng trong công việc và dự án. Dù cho thực tế rằng việc áp dụng coding convention trong một team phát triển là điều không dễ nhưng đấy vẫn được xem là một trong những checklist bắt buộc khi triển khai viết code. Bài viết hôm nay chúng ta cùng tìm hiểu xem code convention là gì và một số quy tắc chung khi viết code trong lập trình nhé.

Code convention là gì?

Code convention là một tập hợp các quy tắc chung dành cho lập trình viên khi viết code nhằm giúp source code dễ đọc, dễ hiểu, dễ quản lý và bảo trì trong tương lai. Trong một dự án có nhiều thành viên, nếu mỗi người viết code theo một “kiểu” (style) khác nhau thì việc đọc code sẽ trở nên vô cùng khó khăn. Chính vì vậy mà coding convention được xem như một quy ước cơ bản áp dụng từ trước khi bắt đầu triển khai dự án.

Tác dụng của Code convention:

• Giúp nâng cao hiệu quả khả năng làm việc nhóm
• Tạo sự đồng bộ cao trong source code cũng như trong hiểu biết của các thành viên về nghiệp vụ dự án
• Tạo điều kiện thuận lợi cho các bước bảo trì và nâng cấp phần mềm
• Giúp các thành viên trong team có khả năng review lại source code của chính mình và người khác, đồng thời cũng dễ dàng tìm được các lỗi tiềm ẩn trong code
• Tạo sự thống nhất giữa các dự án trong một tổ chức, từ đó giúp nâng cao khả năng tái sử dụng source code giữa các bộ phận.

Với mỗi ngôn ngữ lập trình khác nhau thì sẽ có những bộ coding convention khác nhau dành riêng, mỗi team hay dự án có thể lựa chọn và áp dụng. Chẳng hạn như với Java chúng ta có bộ convention của Oracle hay của Google. Với C# có bộ convention của Microsoft hay như Airbnb cung cấp rất nhiều bộ coding convention dành cho JavaScript, Ruby hay HTML/ CSS. Code convention sẽ được áp dụng đối với tất cả các thành viên trong dự án (lập trình viên viết code) trên các Code Editor hay IDE tích hợp sẵn. Ngoài ra, coding convention còn thường được sử dụng cho các bước auto deploy (build tự động trên các môi trường kiểm thử) và được xem như một bước kiểm thử trước khi thực hiện build và chạy chương trình.

Hầu hết các IDE phổ biến hiện nay đều có tính năng thiết lập code style (tương tự code convention), nó sẽ thực hiện việc check code convention ngay lúc chúng ta viết code và có thể đưa ra các gợi ý chỉnh sửa ngay lập tức, rất tiện lợi và hữu ích dành cho anh em lập trình viên.

Một số quy tắc chung khi viết code lập trình

Mục đích của việc viết code là để giải quyết được bài toán đặt ra với những logic xử lý tối ưu; đồng thời càng đơn giản dễ hiểu thì càng tốt. Viết code không chỉ để chạy được, chạy đúng mà còn dành để cho những thành viên khác trong team, hoặc những người tiếp nhận source code về sau đọc hiểu; vì vậy hãy luôn giữ cho code của mình “sạch”, “rõ ràng” và “đơn giản” (clean, clear and simple).

Xem thêm các việc làm PHP lương cao trên TopDev

Quy tắc đặt tên

Quy tắc này áp dụng trong việc đặt tên các biến, hằng số, class, function,… 3 quy tắc đặt tên phổ biến thường được sử dụng trong nhiều ngôn ngữ lập trình khác nhau:

• Camel case: viết thường từ đầu tiên trong cụm, những từ còn lại thì viết hoa ký tự đầu. Ví dụ như firstName, lastName. Camel case thường sử dụng cho khai báo tên biến, tên hàm hay tên phương thức.
• Pascal case: viết hoa ký tự đầu của mỗi từ trong cụm. Ví dụ FirstName, LastName. Quy tắc này thường được áp dụng khi khai báo tên class hoặc sử dụng cho tên biến trong một số ngôn ngữ lập trình.
• Snake case: toàn bộ các từ đều viết thường và được phân cách bởi dấu “_” (underscore). Ví dụ first_name, last_name. Snake case thường dùng cho việc đặt tên hằng số hoặc tên của chương trình.

Quy tắc số lượng

• Một lớp (class) không nên vượt quá 500 dòng
• Một hàm (function) không nên vượt quá 30 dòng, không nên chứa quá 5 tham số và chỉ nên làm duy nhất một việc
• Một dòng code không nên dài quá 80 ký tự
• Một câu lệnh không nên lồng quá 4 cấp

Quy tắc comment

• Không nên comment out đoạn code không dùng, hãy xóa nó đi
• Comment để làm rõ logic xử lý đoạn code phức tạp
• Comment để lưu ý, cảnh báo những trường hợp có thể xảy ra trong logic luồng code
• Không nên comment để giải thích những logic, tính năng đơn giản, chú thích những điều hiển nhiên. Thay vào đó nên đặt tên function, class thể hiện nó.

Quy tắc xuống hàng

• Nếu một hàm có nhiều cấp lồng nhau, mỗi cấp nên được xuống dòng
• Các đoạn code bằng cấp nên ở cùng một cột với nhau (khoảng cách với lề sẽ bằng nhau)
• Nên xuống hàng trước các toán tử

Đây là một số coding convention cơ bản mà bạn thường/ nên áp dụng trong nhiều ngôn ngữ lập trình khác nhau. Ngoài ra, mỗi ngôn ngữ hoặc framework sẽ có những bộ convention được đề xuất sử dụng, các bạn có thể tự tìm hiểu thêm để áp dụng vào từng dự án một cách hiệu quả nhất nhé.

Kết bài

Rõ ràng việc áp dụng code convention là rất cần thiết trong mọi dự án phát triển phần mềm đối với team lập trình; vì vậy hiểu rõ và áp dụng được nó trong công việc sẽ giúp bạn lập trình tốt hơn, có khả năng làm việc với nhiều thành viên cùng hoặc khác môi trường hay ngôn ngữ lập trình.

Hãy áp dụng những quy tắc chung mà bài viết đề cập cũng như tìm hiểu thêm các quy tắc khác được đề xuất vào việc viết code của bạn để xác nhận sự hiệu quả của nó mang lại nhé. Cảm ơn các bạn đã đọc và hẹn gặp lại trong các bài viết tiếp theo của mình.

Tác giả: Phạm Minh Khoa

Có thể bạn quan tâm:

• Code PHP chuẩn convention với PHP CodeSniffer
• Clean Code Android: Bạn đã thật sự hiểu đúng chưa?
• Code PHP làm sao cho sạch (Phần 1)

Xem thêm việc làm CNTT hấp dẫn trên TopDev