10 Nguyên Tắc Vàng Để Viết Code Sạch và Hiệu Quả

Việc viết code bừa bộn giống như sống trong một căn phòng lộn xộn, không chỉ làm ảnh hưởng đến năng suất làm việc mà còn khiến việc tìm kiếm và sửa lỗi trở nên khó khăn. Ngược lại, nếu bạn viết code một cách gọn gàng và sạch sẽ, bạn sẽ có được những lợi ích như sự rõ ràng, dễ quản lý và khả năng kiểm soát tốt hơn các dự án.

Sự Khác Biệt Giữa Lập Trình Viên Gọn Gàng và Lộn Xộn

Hãy xem xét biểu đồ hành trình của hai loại lập trình viên:

• Bad Coder (Đường màu đỏ): Họ bắt đầu nhanh nhưng cũng sập nhanh. Việc viết nhiều dòng code thường dẫn đến nhiều vấn đề phức tạp.
• Clean Code (Đường màu xanh): Họ bắt đầu chậm nhưng nhất quán. Sự phát triển được duy trì và ngày càng gia tăng.

Vậy bạn sẽ chọn đi theo con đường nào?

Chi Phí Của Việc Code Tồi

Trong giai đoạn phát triển đầu, việc thay đổi code kém sẽ tốn kém hơn so với viết code sạch. Tuy nhiên, khi bước vào giai đoạn bảo trì và tái cấu trúc, sự khác biệt giữa chúng sẽ trở nên rõ rệt. Code kém có thể tốn chi phí gần gấp đôi so với code sạch.

Khi đến giai đoạn kế thừa, chi phí duy trì code kém sẽ đạt 100%, trong khi code sạch lại giữ mức chi phí ở 45%. Điều này chứng tỏ rằng code lộn xộn sẽ trở thành một gánh nặng tốn kém trong phát triển phần mềm.

10 Nguyên Tắc Bất Di Bất Dịch Để Viết Code Sạch

1. Sử Dụng Tên Có Ý Nghĩa

Đặt tên biến hoặc hàm là b hoặc x là điều không nên. Hãy đặt tên một cách rõ ràng và dễ hiểu.

// Tên không rõ ràng
let b = 5;

// Tên rõ ràng
let numberOfUsers = 5;

2. Giữ Cho Hàm Tập Trung Vào Một Nhiệm Vụ Duy Nhất (SRP)

Mỗi hàm nên chỉ thực hiện một công việc và thực hiện tốt công việc đó. Đừng để hàm của bạn cố gắng làm quá nhiều việc cùng một lúc.

// Hàm sạch: Một nhiệm vụ
function calculateTotal(a, b) {
    return a + b;
}

3. Viết Comment Tự Giải Thích

Code của bạn nên rõ ràng đến mức không cần phải giải thích thêm. Hãy để nó tự nói lên giá trị của nó.

// Tự giải thích
let userAge = 25;

4. Làm Cho Code Dễ Đọc

Code nên dễ đọc như một câu chuyện. Nếu người khác phải vật lộn để hiểu nó, đó là dấu hiệu của vấn đề.

// Về đọc: Dễ hiểu
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

5. Kiểm Tra Từng Đoạn Mã Bạn Viết

Nếu bạn không viết test cho mã của mình, đừng mong đợi rằng nó sẽ không xảy ra lỗi.

// Kiểm tra đơn vị
const calculator = new Calculator();
console.assert(calculator.add(2, 3) === 5, "Lỗi ở phép cộng");

6. Cẩn Thận Với Các Dependency

Dependency giống như các thỏa thuận, hãy chọn đúng để thành công.

// Dependency: Gửi email bằng Nodemailer
const nodemailer = require('nodemailer');
function sendEmail(to, subject, message) {
    // cấu hình gửi email
}

7. Tổ Chức Dự Án Như Một Cửa Hàng Kinh Doanh

Một dự án được tổ chức tốt sẽ giống như một cửa hàng cao cấp. Nếu codebase của bạn lộn xộn, sẽ không ai muốn xem nó.

8. Giữ Cho Định Dạng Nhất Quán

Không nên viết code như một người có nhiều tính cách. Hãy áp dụng định dạng nhất quán để làm cho code của bạn dễ dàng đọc và hiểu.

9. Tránh Hardcoding Giá Trị

Hardcoding giống như tự tước đoạt khả năng linh hoạt của mã của bạn.

// Không tốt: Hardcoded
function createUser() {
    const maxUsers = 100;
}

10. Giữ Cho Hàm Ngắn Gọn

Nếu hàm của bạn dài hơn 20 dòng, có thể bạn đang cố gắng làm quá nhiều việc trong một hàm. Hãy chia nhỏ nó thành các hàm nhỏ hơn.

function addItemToCart(cart, item) {
    cart.items.push(item);
}

Hy vọng bài viết này sẽ giúp ích cho bạn trong việc viết code sạch và hiệu quả! Đừng quên áp dụng những nguyên tắc này để cải thiện kỹ năng lập trình của mình.
source: viblo