Hướng Dẫn Viết Code Sạch: Những Nguyên Tắc Cơ Bản Bạn Cần Biết

Xin chào mọi người! Hôm nay, mình sẽ chia sẻ một bài viết về cách viết code sạch - một phần quan trọng trong phát triển phần mềm. Mặc dù có rất nhiều lý thuyết về clean code, nhưng ít người thực sự biết cách nhận ra code của mình có sạch hay không.

Clean Code Là Gì?

Clean code không chỉ là code hoạt động, mà còn là code dễ hiểu và dễ bảo trì. Để xác định liệu code của bạn có sạch hay không, hãy tham khảo một số phương pháp dưới đây.

1. Phương Pháp Kẻ Ngốc - Trí Nhớ Ngắn Hạn

Phương pháp này rất đơn giản: Nếu bạn đọc một đoạn code hoặc hàm mà không hiểu trong vòng 5 giây, hãy viết lại nó. Điều này không chỉ giúp bạn mà còn giúp người khác dễ dàng hiểu và review mã của bạn. Bạn chỉ cần dành một chút thời gian để xem lại code, nếu mất nhiều thời gian để hiểu, có lẽ bạn cần làm nó rõ ràng hơn.

2. Phương Pháp Chia Khối

Lấy cảm hứng từ cách viết code trong Python, phương pháp này nhấn mạnh việc nhóm các câu lệnh liên quan gần nhau. Nếu trong một hàm chứa nhiều chức năng, hãy tách chúng ra bằng các dòng trắng để dễ theo dõi. Điều này sẽ giúp người khác nhanh chóng hiểu ý tưởng chính của hàm khi đọc code.

3. Phương Pháp Viết Hàm Nông

Hàm nông là hàm không có nhiều khối lồng nhau. Nếu hàm của bạn bao gồm nhiều câu lệnh if lồng nhau, hãy viết lại cho rõ ràng hơn. Hãy cố gắng tối ưu hóa các biến để tránh phụ thuộc vào nhau. Điều này sẽ giúp reviewer dễ dàng hiểu logic chính của bạn mà không cần đi sâu vào từng chi tiết phụ.

func login(){
  checkLogin();
  redirect();
}
func checkLogin(){
  doCheck();
  saveLog();
}

Ví dụ trên có thể được cải thiện như sau:

func login(){
  checkLogin();
  saveLog();
  redirect();
}
func checkLogin(){
  doCheck();
}

Việc sắp xếp lại như trên giúp người đọc dễ hiểu rằng saveLog() không thuộc về checkLogin(), từ đó tách biệt các chức năng rõ ràng hơn.

4. Phương Pháp Viết Hàm Implicit/Explicit

Hàm implicit là những hàm có tính đóng gói cao, có ít các tham số để giảm thiểu sự phức tạp. Ngược lại, hàm explicit là những hàm có thể mở rộng, nghĩa là có nhiều tham số để tiện cho việc sử dụng trong nhiều trường hợp khác nhau. Việc kết hợp giữa hai kiểu viết này sẽ giúp bạn tạo ra mã sạch mà vẫn linh hoạt.

Kết Luận

Code sạch không chỉ cải thiện hiệu suất làm việc của bạn mà còn giúp cho cả team duy trì và phát triển phần mềm một cách dễ dàng hơn. Hy vọng những phương pháp trên hữu ích cho bạn. Nếu bạn có câu hỏi nào thêm về clean code hoặc muốn thảo luận sâu hơn về chủ đề này, đừng ngần ngại chia sẻ!

source: viblo