12 Bí Quyết Viết Code .NET Sạch, Hiệu Quả và Dễ Bảo Trì
Trong bài viết này, tôi sẽ chia sẻ với bạn 12 mẹo đơn giản, nhưng cực kỳ hiệu quả mà tôi đã áp dụng hàng ngày để viết code .NET tốt hơn, sạch hơn và dễ bảo trì hơn. Hãy cùng khám phá nào!
1. Đặt Tên Rõ Ràng
Khi đặt tên cho biến, phương thức, và lớp trong code của bạn, hãy sử dụng những cái tên rõ ràng, có ý nghĩa. Tên tốt không chỉ giúp tăng khả năng đọc mã mà còn hỗ trợ người khác (cũng như chính bạn trong tương lai) hiểu được ý định của mã mà không cần thêm ngữ cảnh.
Ví dụ tên không rõ ràng:
csharp
public class AccountService
{
private string _str;
private DateTime _dateTime;
private decimal _iNumber;
}Ví dụ tên rõ ràng:
csharp
public class BankAccount
{
private string _ownerName;
private DateTime _expirationDate;
private decimal _balance;
}Hãy nhớ rằng, quy ước đặt tên là rất quan trọng trong việc tăng cường khả năng đọc.
2. Loại Bỏ Comments Thừa
Comment có thể là một phần quan trọng trong việc mã hóa nhưng nếu chúng chỉ giải thích về những gì đang diễn ra, chúng thường làm lộn xộn code. Hãy cố gắng viết code rõ ràng đến mức không cần comment để giải thích những gì bạn đã viết.
Thay bằng code có comment:
csharp
// Calculate the price for the product
var price = product.Price - Math.Max(product.Price * product.Discount / 100, MaxDiscount);Thay bằng phương thức có tên rõ ràng:
csharp
var price = GetDiscountedPrice(product);3. Định Dạng Code Đúng Cách
Định dạng giúp tăng khả năng đọc. Sử dụng thụt lề và khoảng trắng nhất quán sẽ giúp dễ dàng theo dõi cấu trúc của code.
Code không được định dạng tốt:
csharp
public class Calculator{public int Add(int a,int b){return a+b;}}Code được định dạng tốt:
csharp
public class Calculator
{
public int Add(int a, int b)
{
return a + b;
}
}4. Giảm Thiểu Việc Lồng Ghép
Lồng ghép nhiều câu lệnh if có thể làm cho code rất khó đọc và bảo trì.
Ví dụ không tốt:
csharp
if (user is not null)
{
if (user.IsActive)
{
if (user.HasPermission)
{
// Perform action
}
}
}Điều này có thể được cải thiện như sau:
csharp
if (user is null || !user.IsActive || !user.HasPermission)
{
return;
}5. Trả Về Sớm
Đừng đợi cho đến khi tất cả các kiểm tra đều hoàn tất; hãy trả về sớm nếu không đáp ứng điều kiện. Điều này giúp giảm lồng ghép và làm cho code dễ đọc hơn.
Ví dụ không tốt:
csharp
if (user is not null)
{
// Check permissions
}Phương pháp tốt hơn:
csharp
if (user is null)
{
return;
}6. Loại Bỏ Từ Khóa Else
Trong nhiều trường hợp, từ khóa else có thể làm cho code trở nên khó đọc hơn. Hãy cân nhắc về việc loại bỏ chúng.
Ví dụ:
csharp
if (condition)
{
// Do something
}
else
{
// Do something else
}Có thể cải thiện bằng:
csharp
if (condition)
{
// Do something
}
return;
// Do something else7. Tránh Phủ Định Kép
Hạn chế sử dụng phủ định kép trong các câu lệnh điều kiện. Chúng có thể gây nhầm lẫn.
Ví dụ không tốt:
csharp
if (!user.IsNotActive)
{
// User is active
}Cách tốt hơn:
csharp
if (user.IsActive)
{
// User is active
}8. Tránh Số và Chuỗi Ma Thuật
Số và chuỗi ma thuật có thể làm cho code khó hiểu. Hãy thay thế chúng bằng hằng số hoặc enum rõ ràng.
Ví dụ:
csharp
if (user.MembershipLevel == "Silver")
{
// Process user order
}Cách tốt hơn:
csharp
if (user.MembershipLevel == MembershipLevels.Silver)
{
// Process user order
}9. Kiểm Soát Số Lượng Tham Số Phương Thức
Giới hạn số lượng tham số ở dạng ba hoặc ít hơn. Hãy nhóm chúng vào một lớp riêng biệt nếu có nhiều tham số liên quan.
10. Áp Dụng Nguyên Tắc Đơn Nhiệm (SRP)
Một phương thức hoặc lớp chỉ nên có một lý do thay đổi. Điều này giúp đơn giản hóa bảo trì và làm rõ code.
11. Sử Dụng Dấu Ngoặc Nhọn Đúng Cách
Hãy luôn sử dụng dấu ngoặc nhọn cho các câu lệnh điều kiện, ngay cả khi chúng chỉ có một dòng. Điều này giúp tránh lỗi trong tương lai.
12. Không Trả Về Null Cho Các Tập Hợp
Đừng trả về tập hợp null. Thay vào đó, hãy trả về một tập hợp rỗng để tránh lỗi NullReferenceException.
Kết Luận
Đây là 12 mẹo nhỏ mà bạn có thể áp dụng để cải thiện chất lượng code .NET của mình. Hãy thử áp dụng chúng ngay hôm nay để thấy sự khác biệt trong công việc lập trình của bạn!
source: viblo
