Bắt quy tắc StyleCop SA1503 CurlyBracketsMustNotBeĐược phép trở nên linh hoạt hơn

Question

Tôi đang gặp khó khăn với quy tắc StyleCop SA1503 (CurlyBracketsMustNotBeOmitted).

Trong mã của tôi, tôi khá thường xuyên có một mô hình như sau:

public void SomeFunction(string someArg) 
{ 
    if (string.IsNullOrEmpty(someArg)) throw new ArgumentNullException("someArg"); 

    // rest of the function here 
} 

Lý do đằng sau này là để tiết kiệm không gian thẳng đứng khi thực hiện nhiều kiểm tra xác nhận trên một đối số duy nhất và/hoặc kiểm tra trên nhiều tranh cãi. Logic trong kiểm tra như vậy thường đơn giản và súc tích và tương tự như vậy đối với ngoại lệ bị ném.

Tuy nhiên, tôi sẽ bao giờ ghi

if (someConditional) 
    DoSomeStuff(); 

tôi sẽ luôn viết

if (someConditional) 
{ 
    DoSomeStuff(); 
} 

Vì vậy, trong bản tóm tắt:

• Sử dụng dấu ngoặc nhọn nếu câu lệnh if được chia trên nhiều dòng
• Không sử dụng dấu ngoặc nhọn để xác thực đối số đơn giản, v.v. có thể dễ dàng (và dễ đọc) được đặt trên một dòng

StyleCop có thể giúp tôi ở đây không?

Answer 1

Như đã đề cập, các quy tắc StyleCop không tự nguyện được bật hoặc tắt và không thể tùy chỉnh. Nó sẽ là tốt đẹp để có một cách đơn giản của các quy tắc tùy biến nhưng tiếc là bạn sẽ cần phải viết chúng từ đầu. Cách tôi đã sử dụng StyleCop là tập trung vào việc sử dụng càng nhiều quy tắc dựng sẵn càng tốt và nơi tôi thực sự có vấn đề cơ bản với quy tắc (ví dụ: tài liệu mã), tôi chỉ cần tắt nó đi. Tôi không quan tâm đủ về các ngoại lệ để đi đến mức độ viết các quy tắc tùy chỉnh.

Answer 2

StyleCop (và tôi đồng ý ở đây) muốn bạn chia thành nhiều dòng. Nó không giống như các câu lệnh trên một dòng, vì lý do chính đáng (có thể cho là) ​​- điều này gây ra một mẫu sử dụng không nhất quán cho các câu lệnh if, đó là một trong những lý do mà quy tắc tồn tại ngay từ đầu.

Để nhận được hành vi bạn đang hiển thị, bạn có thể cần phải sử dụng SDK để viết quy tắc tùy chỉnh của riêng mình cho trường hợp cụ thể đó và sau đó tắt quy tắc mặc định.