Tôi có nên chặn CA2204: Chữ viết phải được viết đúng chính tả không?

Question

Gần đây tôi đã nâng cấp dự án của mình từ Visual Studio 2008 lên Visual Studio 2010.

Bằng cách bật Phân tích mã, tôi nhận được rất nhiều cảnh báo dẫn đến quy tắc CA2204: Văn học phải được viết đúng chính tả.

EDIT:

Hãy nói rằng tôi có một phương pháp gọi là GetResult(), và trong đó tôi muốn ném một ngoại lệ đối với một số lý do. Tôi muốn ngoại lệ để nói "GetResult() has failed for some reason". Điều này sẽ cho tôi cảnh báo vì GetResult không phải là một từ. Tôi sẽ không nhận được cảnh báo về tên phương thức GetResult(), chỉ khi tôi đặt nó vào một chuỗi. Điều này là do Nhận và Kết quả là các từ hợp pháp.

Tôi không tin rằng viết GetResult() has failed for some reason là giải pháp.

EDIT: Trong MSDN nó nói:

Quy tắc này phân tích các chuỗi chữ diễn tả bằng lời, tokenizing từ ghép, và kiểm tra chính tả của mỗi từ/thẻ.

Điều đó có nghĩa là GetResult phải được kiểm tra là hai từ: "Nhận" và "Kết quả" không?

Tôi có nên chặn CA2204 không?

Answer 1

"Can't initialize MyClass" không phải là thông điệp tốt để nhà phát triển giới thiệu về mã. Nó hiếm khi hỗ trợ gỡ lỗi và nó chỉ gây nhầm lẫn cho người dùng cuối nếu nó được hiển thị.

Nói chung, tôi có thể nói không chặn thông báo vì lỗi chính tả khiến cho chúng trông có vẻ nhiều hơn so với thực tế và đó không phải là thông điệp bạn muốn truyền đạt với ứng dụng của mình.

Trong trường hợp cụ thể này, nó thực sự là cảnh báo về thông báo lỗi kém - cho người dùng biết cách sửa, tự động sửa hoặc đưa lý do thực sự mà nó không khởi chạy trong nhật ký lỗi của bạn.

EDIT: Bao gồm chỉnh sửa OP của
Something bạn có thể mất từ ​​cảnh báo này là bạn không nên tiết lộ chi tiết mã như là một phần của một thông báo lỗi (chủ yếu là bởi vì họ sẽ được đưa vào các cuộc gọi stack khi bạn đăng nhập sự ngoại lệ).

GetResult() has failed for some reason
Giả sử "một số lý do" là quyền.Tin nhắn có thể đọc:

Bạn không có quyền xem kết quả này.

Không cần phải đề cập đến phương pháp cụ thể không thành công do theo dõi ngăn xếp có thể được ghi nhật ký tự động.

Answer 2

Có thể bạn không nên đặt tên lớp thành chữ? Điều gì về việc sử dụng hoặc xác định ngoại lệ có thể được ném như thế này:

throw new CantInitializeClassException(innerException, typeof(MyClass); 

Ý tưởng của tôi là di chuyển nhiều thông tin hơn đến nhiều trường hợp ngoại lệ cụ thể hơn. Tôi khuyên bạn nên sử dụng mẫu ở trên thay vì throw new ApplicationException("Cant initialize MyClass");

Answer 3

Một cách để khắc phục điều này là không thêm tên loại vào chuỗi trực tiếp. Thay vào đó, hãy chuyển nó thành một tham số. Ví dụ:

var msg = String.Format("Can't initialize {0}", typeof(MyClass).Name); 

Điều này có lợi cho cả việc đi lại quy tắc FxCop và an toàn cho việc tái cấu trúc.

Answer 4

CA2204 là tất cả về chính tả. Thật không may ngay cả trong VS2012 nó vẫn còn có một lỗi gây phiền nhiễu cũ, nơi nó không tokenize từ ghép: http://connect.microsoft.com/visualstudio/feedback/details/521030

Điều này khiến tôi tắt quy tắc này trong bộ quy tắc phân tích mã của chúng tôi.