Hướng dẫn cách đơn giản và hiệu quả nhất để viết code dễ đọc

Mời các bạn cùng Quản Trị Mạng tìm hiểu bài viết hướng dẫn cách đơn giản và hiệu quả nhất để viết code dễ đọc dưới đây nhé!

Hầu hết ai trong số chúng ta cũng biết cách viết code nhưng chỉ tội lười biếng nên chúng ta không làm theo. Đây là một trong những cách viết code sạch bị đánh giá thấp nhất và còn có một vài lời đồn thổi không đúng sự thật, nhưng tôi sẽ đề cập đến sau. Phương pháp đó là, chuyển hóa code thành hàm!

Tôi biết rằng chúng ta đều chuyển code thành các hàm nhưng không quá thường xuyên. Hãy lấy đoạn mã dưới đây, một đoạn code từ công ty cũ của tôi làm ví dụ. Hãy xem qua từng điểm được đề cập ở bên dưới!

Hướng dẫn cách đơn giản và hiệu quả nhất để viết code dễ đọc

1. Trông nó như đang khôi phục lại một số nhóm. Mặc dù chỉ có 2 dòng nhưng bạn có thể rút ra một method hợp lý từ đó.

2. Ban đầu nó chắc chắn phải bắt đầu bằng một flag. Lập trình viên hẳn cảm thấy khó chịu về việc tại sao chỉ có một dòng code thôi cũng phải có một method riêng. Sau đó một flag khác được thêm vào và tiếp là một flag nữa!

3. Có vẻ như chúng ta đang tạo ra một ngăn chứa cho khung hình. Tại sao code bậc cao lại phải quan tâm đến cách nó khởi tạo?

4. Ngay khi xem qua 4 dòng code, tôi đã hiểu tại sao chúng ta phải quan tâm đến device information. Tôi biết 4 dòng là không nhiều nhưng nó có thể nhân lên cả chục hoặc cả trăm dòng. Tốt hơn là phải tách ra một method!

5. Đăng nhập trong khi reading flow không hiệu quả. Phải đổi ngay!

6. Tất cả người nghe cần được tách riêng ra trong một method.

Sau khi thực hiện một vài thao tác refactoring (tái cấu trúc):

Sau khi thực hiện một vài thao tác refactoring

Đoạn code đã trở nên bắt mắt hơn trước. Rất dễ lướt qua mà không vướng phải những chi tiết không cần thiết. Một method được xác định sẽ không yêu cầu bất kỳ dòng comment nào.

Lời khuyên:

  • Không làm nhiễu reading flow bằng những hiệu ứng phiền phức hoặc điều kiện phức tạp.
  • Xác định các method ngắn. Nó giúp việc giải thích dễ dàng hơn, flow rõ ràng hơn, scope ngắn hơn, lúc đó bạn sẽ có cảm giác tốt hơn.
  • Thực hiện tất cả các khai báo của code giảng nghĩa.

Việc thêm 2 dòng vào một method có sẵn luôn dễ dàng. Tuy nhiên, bạn cũng phải chú ý phần code có thay đổi ở trên và dưới đòi hỏi một khoảng riêng, nếu có, phải tách method ngay. Trong mỗi method phải áp dụng những logic phù hợp riêng, như thế các contributor sau này mới thêm các thay đổi theo mỗi method tương ứng.

Kết luận

Liệu việc tăng số lượng method có làm ảnh hưởng xấu đến hiệu suất như nhiều người nhận định hay không? Đây chính là một hiểu lầm tai hại và trong hầu hết các trường hợp, những ảnh hưởng này quá nhỏ để lo ngại. Nếu bạn làm việc với các ngôn ngữ trên JVM thì xin chúc mừng bạn, JVM là một phần mềm tuyệt vời có nhiều tính năng tối ưu hóa thời gian thật sự tuyệt vời. Và hãy chuyển hóa nó…

"Code is like humor. When you have to explain it, it’s bad." — Cory House

Tác giả: Girish Budhwani

Tham khảo thêm một số bài viết:

Chúc các bạn vui vẻ!

Thứ Năm, 22/02/2018 16:35
52 👨 3.109