Mã nguồn bẩn là điều mà mọi lập trình viên đều gặp phải, thường xuất hiện khi làm việc dưới áp lực thời hạn gấp gáp. Mã không chỉ trở nên khó đọc mà còn gây khó khăn trong việc sửa đổi hoặc gỡ lỗi. Để tránh tình trạng này, hãy tuân thủ những quy tắc sau đây.
Mã nguồn bẩn là gì?
Mã nguồn bẩn (hay Dirty Code) là mã lập trình khó đọc, thiếu cấu trúc và tính nhất quán, gây khó khăn cho việc gỡ lỗi và bảo trì. Điều này thường xảy ra khi lập trình viên không tuân theo tiêu chuẩn lập trình hoặc khi họ làm việc dưới áp lực cao.
Tại sao mã nguồn bẩn là một vấn đề nghiêm trọng?
Mã nguồn bẩn có thể gây ra nhiều vấn đề nghiêm trọng trong nhóm phát triển, bao gồm khó khăn trong việc sửa lỗi, tốn kém cho việc bảo trì và gây ra sự nhầm lẫn trong việc hiểu mã của nhau. Hậu quả là mã có thể trôi dạt vào một mớ hỗn độn mà cần nhiều thời gian để khắc phục.
Những quy tắc đơn giản để tránh mã nguồn bẩn
1. Tuân thủ Nguyên tắc Đơn trách nhiệm (SRP)
Mỗi hàm, phương thức hoặc lớp chỉ nên thực hiện một công việc cụ thể. Nếu bạn thấy mình đang viết mã quá phức tạp, hãy chia chúng thành các hàm nhỏ hơn.
Ví dụ không nên:
python
def process_user_data(user):
user['age'] += 1
db.save(user)
print(f"User {user['name']} updated")Ví dụ tốt:
python
def update_user_age(user):
user['age'] += 1
def save_user_to_db(user):
db.save(user)
def log_user_update(user):
print(f"User {user['name']} updated")2. Tránh sử dụng số và chuỗi ma thuật
Sử dụng hằng số thay vì các giá trị cứng để cải thiện khả năng đọc mã.
Ví dụ không nên:
javascript
if (statusCode === 404) {
console.log("Not Found");
}Ví dụ tốt:
javascript
const NOT_FOUND = 404;
if (statusCode === NOT_FOUND) {
console.log("Not Found");
}3. Sử dụng tên biến và hàm mô tả
Tên biến nên phản ánh ý nghĩa của nó. Tránh các từ viết tắt và tên không rõ ràng.
Ví dụ không nên:
python
int a = 5;
String s = "John";Ví dụ tốt:
python
int userAge = 5;
String userName = "John";4. Đừng lặp lại chính mình (DRY)
Tránh việc sao chép và dán mã. Hãy tóm gọn logic lặp lại thành các hàm hoặc lớp riêng.
Ví dụ không nên:
python
print("Welcome, John")
print("Welcome, Mary")Ví dụ tốt:
python
def greet_user(name):
print(f"Welcome, {name}")
greet_user("John")
greet_user("Mary")5. Giữ cho hàm của bạn ngắn gọn
Một hàm dài trên 20-30 dòng biểu hiện rằng nó đang làm quá nhiều việc. Chia nhỏ hàm thành các phần dễ quản lý.
6. Sử dụng chú thích một cách tiết kiệm
Hãy viết mã tự giải thích. Dùng chú thích để làm rõ các phần logic phức tạp, không chỉ mô tả điều hiển nhiên.
Ví dụ không nên:
python
// Increment the counter by 1
counter = counter + 1;Chú thích không cần thiết nếu mã đã rõ ràng:
python
counter += 1;7. Định dạng và sắp xếp mã của bạn
Sử dụng các quy tắc định dạng mã chuẩn (chẳng hạn như PEP8 cho Python, ESLint cho JavaScript). Định dạng tốt không chỉ giúp mã sạch sẽ mà còn dễ đọc hơn cho người khác.
Mã nguồn không chỉ là để máy tính hiểu mà còn là để con người - những đồng nghiệp và chính bạn trong tương lai. Khi bạn viết mã sạch sẽ, bạn hỗ trợ cho những người khác và giảm bớt áp lực trong công việc. Hãy trở thành một lập trình viên chuyên nghiệp, người coi trọng chất lượng mã nguồn.
Cảm ơn bạn đã theo dõi bài viết!
source: viblo
