Ba Luật Của Mã Đọc Được
Khi là các nhà phát triển, chúng ta phấn đấu để viết mã không chỉ hàm nhưng cũng phải dễ hiểu và bảo trì. Trong bài viết này, chúng ta sẽ khám phá ba luật của mã đọc được, sẽ giúp bạn trở thành một lập trình viên tốt hơn và làm cho các đánh giá mã của bạn trở thành một tiện nghi.
Mã của bạn có nói sự thật?
Luật đầu tiên của mã đọc được là viết mã tự tài liệu. Điều này có nghĩa là mã phải rõ ràng và gọn gàng, khiến nó dễ hiểu cho người khác. Một ví dụ tốt của điều này là một hàm tính toán diện tích của một hình tròn. Thay vì có một bình luận giải thích hàm làm gì, tên hàm chính nó phải mô tả, chẳng hạn như calculateAreaOfCircle
. Điều này loại bỏ nhu cầu bình luận không cần thiết và làm mã đọc được hơn.
Tránh Số Ảo
Luật thứ hai của mã đọc được là tránh số ảo. Số ảo là các giá trị số xuất hiện trong mã mà không có giải thích. Chúng có thể khiến mã trở thành khó hiểu và bảo trì. Một phương pháp tốt hơn là sử dụng các hằng số tên mô tả cho các giá trị này. Ví dụ, thay vì có một hàm tính thuế dựa trên một giá trị nhất định, bạn có thể định nghĩa một hằng số HIGH_VALUE_ITEM_TAX
và sử dụng nó trong hàm. Điều này làm mã đọc được hơn và dễ hiểu hơn.
Tránh Đa Tham Số Hàm
"Luật 3: Tránh đa tham số hàm"
Luật thứ ba của mã đọc được là tránh đa tham số hàm. Khi một hàm có quá nhiều tham số, nó có thể trở thành khó đọc và bảo trì. Một phương pháp tốt hơn là tạo một đối tượng bao gồm tất cả các trường này, và sau đó sử dụng một builder để tạo đối tượng. Điều này làm mã đọc được hơn và dễ hiểu hơn.
Kết Luận
Bằng cách tuân thủ ba luật của mã đọc được, bạn có thể viết mã dễ hiểu và bảo trì. Nhớ, mục đích của mã đọc được là làm cho dễ hiểu cho người khác để hiểu mã làm gì, không cần đọc qua nhiều bình luận hoặc phức tạp không cần thiết. Bằng cách viết mã tự tài liệu, tránh số ảo và tránh đa tham số hàm, bạn có thể làm cho các đánh giá mã của bạn trở thành một tiện nghi và trở thành một lập trình viên tốt hơn.