Coding Standards là gì? tuy nhiên, một số người, đa số beginner thường sở hữu suy nghĩ: “code sao chả được miễn chạy không lỗi, ra hậu quả đúng là được”. Qua bài viết dưới đây sẽ cung cấp thêm nhiều nội dung hơn đến các bạn đọc, cùng xem xét thêm nhé!
Coding Standards là gì?
Coding Standards (Quy chuẩn mã nguồn) là một bộ quy tắc quy định cách viết code của một chương trình mà lập trình viên phải tuân theo khi tham gia vào dự án tăng trưởng chương trình đó. Tùy thuộc theo mỗi dự án mà sẽ có nhiều chuẩn xác không giống nhau.
Môt bộ quy tắc bao gồm:
- Đặt tên biến, hằng, hàm, class, …
- Khoảng trắng, tab
- Khai báo và sử dụng biến
- Bình luận
- Độ dài tối ưu mỗi dòng code, mỗi tệp, …
- …
Những Ưu và nhược điểm của Coding Standards là gì?
Ưu điểm
Việc xây dựng và áp dụng Coding Standards đem tới nhiều tiện ích như:
- Giúp các lập trình viên trình bày các khối code một bí quyết chuyên nghiệp và hiểu sâu chuyện gì đang diễn ra với code của mình.
- Dễ dàng tìm kiếm và khắc phục những lỗi sai trong code.
- Những lập trình viên newbie có thể làm quen và bắt nhịp một cách nhanh chóng, tránh mắc đi mắc lại cùng một sai lầm.
- Hạn chế tình trạng mỗi người một phong cách viết code khi thực hiện công việc group dẫn tới xung đột.
- Giúp người đối diện dễ dàng hiểu mã nguồn của bạn.
Điểm không tốt
- Chuẩn xác trong viết code có khả năng tránh sự sáng tạo.
- Dễ bị lãng quên trong lúc lập trình viên viết code.
Thực tế cho chúng ta thấy, các dự án có những thành viên cùng tham gia sẽ diễn ra suôn sẻ hơn nếu được quy định Coding Standards ngay từ khi bắt đầu. Tuy vậy chuẩn xác viết code không hẳn là chìa khóa để đạt cho được thành công. Thậm chí trong một số hoàn cảnh, nếu áp dụng quy chuẩn một bí quyết gượng ép, gò bó sẽ không mang lại hiệu quả gì, thậm chí còn gây tác dụng ngược.
Coding Standards có quan trọng không?
Coding standards giúp:
- Các lập trình viên biết rõ mình đang làm gì, và chuyện gì đang xảy ra với code của họ. Vì vậy họ đơn giản tìm và sửa các lỗi sai.
- Những người mới có khả năng làm quen nhanh hơn, không bị mắc lỗi lặp đi lặp lại.
- Những người mới không mất công tạo phong cách code riêng và “bảo vệ nó đến chết”.
- Mọi người sẽ ít mắc lỗi hơn trong môi trường nhất quán.
Xem thêm Cách xem nhật kí web chat zalo trên máy tính của bạn
Tổng hợp những quy tắc chung khi viết Code
Quy tắc chung để viết code “sạch”
- Coding Standards là gì? Suy nghĩ giản đơn và viết code đơn giản nhất có thể.
- Luôn dọn code sạch hơn lúc ta nhận nó lần đầu, dù là của mình hay của ai khác.
- Luôn tìm ra nguyên nhân gốc rễ của vấn đề.
Quy tắc đặt tên
Bí quyết đặt tên những định danh (bao gồm các biến, hằng số, class,…) cũng có tác động không nhỏ đến năng lực đọc hiểu code. Hãy hình dung một ứng dụng khổng lồ như Windows tuy nhiên mỗi hàm số chỉ được đặt tên như a, b, c, function1, function2,… thì đảm bảo việc quản lý và bảo trì code là vô cùng khó khăn.
Có ba quy tắc đặt tên rộng rãi là camelCase, PascalCase và snake_case. Cụ thể:
- Camel case: Từ đầu tiên trọng cụm từ được viết thường, những ký tự còn lại thì viết hoa, áp dụng cho tên hàm, tên biến và tên phương thức. Ví dụ:
firstName, lastName, getName(), findMember(),… - Pascal case: Viết hoa ký tự đầu tiên của toàn bộ từ có trong cụm, thường áp dụng cho tên class hay tên biến. Ví dụ:
MickeyMouse, FirstName,… - Snake case: tất cả chữ cái đều viết thường, phân tách nhau bằng dấu “_”, thường dành cho tên hằng số hoặc tên của chương trình. Ví dụ:
program_final, get_max(),…
Quy tắc về số lượng
Một số quy tắc về 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 giống như bộ quy tắc của Oracle có ghi như sau:
- Một dòng Code đừng nên dài quá 80 ký tự.
- Một câu lệnh có thể lồng tối đa 4 cấp.
- Một hàm không nên chứa quá 5 tham số.
- Một hàm không nên quá 30 dòng.
- Một class không được vượt 500 dòng,…
- Mỗi hàm chỉ có thể làm duy nhất một việc, nếu như hành động hai mục đích khác nhau thì tên hàm cần thể hiện rõ việc làm này. Ví dụ:
increaseDonwnloadCounterAndSaveToDatabase.
Xem thêm Website động là gì? Website tĩnh và website động khác nhau ra sao?
Quy tắc xuống hàng
Coding Standards là gì? Theo bộ quy tắc của Oracle:
- Nếu một hàm có những cấp lồng nhau, mỗi cấp có thể xuống dòng.
- Các đoạn code bằng cấp có thể ở cùng một cột với nhau, dòng xuống hàng có thể tiếp tục 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ư +, -, *, ?,…).
Qua bài viết trên đây Webhay.vn đã cung cấp các thông tin về Coding Standards là gì? Những Ưu và nhược điểm của Coding Standards. Hy vọng những thông tin trên của bài viết sẽ hữu ích với các bạn đọc. Cảm ơn các bạn đã dành thời gian để xem qua bài viết này nhé!
Vũ Thơm – Tổng hợp
Tham khảo ( codelearn.io, ecci.com.vn, … )
