How to write clean code- Hatonet

7 Mẹo Để Viết Mã Sạch 🧯

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

Khi bạn tạo một biến hoặc hàm, hãy đặt tên sao cho nó thể hiện rõ chức năng của nó.

Hãy nghĩ về việc đặt tên như khi bạn đặt tên cho một thư mục trên máy tính của mình. Thay vì gọi nó là b, hãy gọi nó là numberOfUsers. Bằng cách này, bạn không cần thêm chú thích để giải thích b là gì.

Example:

let numberOfUsers = 5; // Clear and easy to understand

2. Tuân Thủ Nguyên Tắc Trách Nhiệm Đơn (SRP)

Một hàm chỉ nên thực hiện một nhiệm vụ và làm nó tốt.

Điều này giúp mã dễ hiểu và dễ sửa chữa khi cần thiết. Nó giống như việc dùng một công cụ cho một nhiệm vụ, chẳng hạn như bút chì để viết và kéo để cắt.

Example:

function addNumbers(a, b) { return a + b; }

Hàm này chỉ cộng hai số lại với nhau. Nó không làm gì khác.

3. Tránh Các Chú Thích Không Cần Thiết

Thay vì thêm chú thích khắp nơi, hãy cố gắng làm cho mã của bạn tự giải thích bằng cách sử dụng tên rõ ràng.

Chỉ sử dụng chú thích khi có điều gì đó phức tạp hoặc cần lưu ý đặc biệt. Quá nhiều chú thích có thể làm mọi người bối rối. 😕🤬

Example:

// Good: Clear name, no extra comment needed
let userAge = 25; 

// Bad: Unclear name, needs a comment
let a; // age of the user

4. Giữ Mã Của Bạn Dễ Đọc

Sử dụng khoảng trắng, thụt lề và ngắt dòng để giữ cho mã của bạn gọn gàng.

Cũng giống như viết một đoạn văn, bạn nên chia mã của mình thành những phần nhỏ hơn để nó không bị dồn vào một dòng.

Example:

// Good Code
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Bad Code
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

5. Viết Các Bài Kiểm Tra Đơn Vị

Các bài kiểm tra đơn vị là những lần kiểm tra cho mã của bạn.

Chúng đảm bảo rằng mọi thứ hoạt động như nó nên có. Khi bạn thay đổi mã của mình, những bài kiểm tra này sẽ cho bạn biết nếu có điều gì đó bị hỏng.

Example:

function add(a, b) {
    return a + b;
}

// Test
console.assert(add(2, 3) === 5, 'Test failed: 2 + 3 should be 5');

6. Cẩn Thận Với Các Phụ Thuộc

Khi bạn xây dựng phần mềm, hãy cố gắng giữ cho các thành phần tách biệt để chúng không phụ thuộc quá nhiều vào nhau.

Ví dụ, một chiếc máy rửa bát có thể ở bất kỳ bếp nào, không chỉ ở một bếp cụ thể. Cách đó dễ quản lý hơn.

7. Tổ Chức Dự Án Của Bạn

Giữ cho các tệp và thư mục của bạn được tổ chức, giống như việc giữ cho bàn làm việc của bạn sạch sẽ. Điều này giúp bạn dễ dàng tìm kiếm mọi thứ khi dự án của bạn phát triển lớn hơn.

Image of writing clean code by codewithshahan

Example:

Sử dụng các thư mục như components, services và utils trong dự án của bạn.
Giữ các tệp tương tự lại với nhau để bạn biết nơi cần tìm kiếm.

News