Hướng dẫn cách viết clean code cho lập trình viên (P1)

5024
cách viết clean code

Trong quá trình viết code, các lập trình viên chúng ta sẽ phải gặp những đoạn code trong nhiều trường hợp khác nhau. Bài viết này sẽ tìm hiểu về các cách viết clean code, giúp code dễ đọc hơn. Qua đó có thể giúp cho người đồng nghiệp có thể hiểu được những đoạn code một cách dễ dàng hơn.

Xem thêm Clean code là gì?

Làm cho luồng code dễ đọc hơn

Thứ tự của các biến trong điều kiện

Hãy xem thứ tự code 2 trường hợp sau:

Có thể nhận thấy cách viết đầu tiên cho ta cảm giác dễ đọc hiểu hơn.

Xét tiếp 2 trường hợp sau:

Cách viết đầu tiên vẫn dễ đọc hiểu hơn. Sau đây là công thức để cho các thứ tự trên:

Thứ tự của if/else

Khi chúng ta viết đoạn code thực hiện if, else thường tự do lựa chọn thứ tự của chúng. Ví dụ chúng ta có thể viết:

Hoặc viết:

Có một số nguyên tắc cho thằng này như sau:

  • Ưu tiên trường hợp positive trước thay vì negative,

  • Ưu tiên case đơn giản trước. Có một số trường hợp case phủ định đứng trước sẽ dễ đọc hơn.
    Ví dụ:

Tránh dùng do/while, goto

Khi đọc code ta đọc logic từ trên xuống dưới, nên trường hợp sử dụng do/while làm người đọc code sẽ khó hiểu. Thay vào đó, hãy sử dụng while sẽ làm code dễ đọc, dễ hiểu hơn.

Sử dụng return trong function

Một số người thường nghĩ sử dụng quá nhiều return trong function là không tốt, điều này là không hợp lý. Chúng ta có thể sử dụng return trong function để khiến code dễ đọc và làm cho logic của function đơn giản hơn. Việc sử dụng return có thể thu gọn lại code như trong các ví dụ bên dưới.

Ví dụ:

Tối thiểu hóa nesting

Khi sử dụng quá nhiều if lồng nhau sẽ dẫn đến khó hiểu cho người đọc.

Ví dụ:

Khi nhìn vào thẻ đóng đầu tiên của permission_result != SUCCESS người đọc sẽ thường hiểu, tiếp theo sẽ đến trường hợp permission_result == SUCCESS và quên mất rằng điều kiện này đang nằm trong một điều kiện khác là user_result == SUCCESS.

Chúng ta có thể tối thiểu hóa bằng cách sử dụng return như trên.

Bằng cách sử dụng return sớm như trên ta có thể chuyển về dạng một vòng lặp khiến code dễ đọc và logic cũng dễ hiểu hơn.

  • Loại bỏ nesting khỏi vòng lặp.
    Ví dụ:

  • Ta có thể sử dụng return và continue để loại bỏ if:

  Mẹo tối ưu code ứng dụng React lập trình viên phải biết
  Cách tối ưu code Laravel của bạn

Tối ưu biểu thức lớn

Dùng biến

Trường hợp dùng biến để giải thích. Ví dụ

Một ví dụ khác về sử dụng biến làm code dễ hiểu hơn

Logic ở đây là người dùng có phải là chủ sở hữu của document? Nên ta có thể viết lại code

Việc sử dụng biến trên có thể khiến người đọc dễ hiểu hơn, hơn nữa có thể giúp người đọc hiểu được mục đích của hàm ta viết ra.

Luật morgan

Ta có thể sử dụng luật De Morgan như sau:

Ví dụ:

Kết luận

Trên đây là những kiến thức mình tìm hiểu để chia sẻ cho bạn cách viết clean code, giúp dễ đọc, dễ review hơn. Hi vọng bài viết sẽ có ích cho mọi người. To be continued…

Nguồn: Sách THE ART OF READABLE CODE

Có thể bạn quan tâm:

Xem thêm việc làm Software Developers hot nhất tại TopDev

TopDev via viblo

  Heroku là gì? Cách đưa ứng dụng lên Heroku
  9 tip tối ưu code Nodejs dành cho lập trình viên
SHARE