Viết code “sạch” là topic được rất nhiều dev quan tâm, nhưng viết code “sạch” là gì và tại sao nhiều người lại quan tâm đến vấn đề đó như vậy? Hãy cùng theo dõi bài viết dưới đây để được giải đáp nhé!

1. Định nghĩa

Nói ngắn gọn, viết code “sạch” là viết code sao cho lập trình viên khác có thể đọc, hiểu, dễ dàng mở rộng và sửa đổi.

2. Tại sao lại nên viết code “sạch”

Nhiều người vẫn còn suy nghĩ rằng “Code của tôi chạy, khách hàng của tôi hài lòng, vậy tại sao tôi phải quan tâm đến việc viết “code sạch”?”

Ngay cả khi code của bạn hiện đang chạy tốt thì bạn cũng nên tập thói quen viết code “sạch”, vì nếu code không rõ ràng ngay từ đầu thì về sau sẽ rất tốn kém, khó khăn và mất nhiều thời gian trong việc bảo trì, update hay mở rộng code.

3. 7 tips viết code “sạch”

  • Sử dụng tên biến và tên hàm rõ ràng: Code sẽ trở nên dễ đọc hơn nhiều nếu bạn viết và mô tả đầy đủ các tên biến và tên hàm.

  • Viết các hàm ngắn với một nhiệm vụ duy nhất: các hàm sẽ dễ hiểu, dễ đọc và dễ bảo trì hơn nếu chúng chỉ làm đúng duy nhất một nhiệm vụ. Nếu có gặp bug trong quá trình chạy thì có thể dễ dàng truy được bug từ đâu ra. Ngoài ra, code có thể tái sử dụng nhiều lần.

  • Viết documentation đầy đủ: điều này sẽ giúp cho bạn hoặc các lập trình viên khác hiểu được đoạn code đó đang làm nhiệm vụ gì và tại sao.

  • Hãy nhất quán: tính nhất quán chính là chìa khóa của mọi vấn đề. Khi không có Git Blame sẽ không ai có thể nhìn vào code base mà xác định được người viết đoạn code đó. Vì vậy, đầu tiên bạn cần phải thiết lập style guide và linter để thực thi các tiêu chuẩn này. Việc thiết lập những thứ đó sẽ giúp tiết kiệm thời gian khi bạn làm việc và đảm bảo rằng bạn có một số tiêu chuẩn và tính nhất quán trên code base của mình.

  • Encapsulation và modular: Hãy chia các program dài thành các file khác nhau để code của bạn có tính mô-đun và dễ hiểu hơn. Vì các file dài thường khó sàng lọc và đôi khi bạn sẽ muốn sử dụng 1 đoạn code nhỏ từ dự án này cho dự án khác. Bên cạnh đó, việc nhóm các hàm hoặc biến giống nhau có thể giúp bạn tái sử dụng được nhiều lần.

  • Áp dụng Quy tắc của Sandi Metz: Sandi Metz - Lập trình viên và tác giả người Mỹ, trong cuốn sách “Practical Object-Oriented Design in Ruby” bà đã đưa ra 4 nguyên tắc được rất nhiều lập trình viên áp dụng cho đến ngày nay:

    • Các class không được dài hơn 100 dòng code.

    • Các method và function không được dài hơn 5 dòng code.

    • Truyền không quá 4 tham số vào một method.

    • Controller chỉ có thể khởi tạo một object.

  • Áp dụng Nguyên tắc DRY (Don’t Repeat Yourself): Nguyên tắc này có nghĩa là đừng viết lặp bất kỳ một đoạn code nào mà hãy đóng gói nó thành phương thức riêng. Đến khi cần thì chỉ cần gọi tên nó ra. DRY thực sự rất có ích trong việc lập trình, đặc biệt trong những ứng dụng lớn, nơi mà code được bảo trì liên tục, được thay đổi và mở rộng bởi nhiều lập trình viên khác.

 VietnamWorks inTECH