Tôi có thể sử dụng ReSharper để thực thi các tiêu chuẩn nhận xét không?

Question

Gần đây tôi đã chơi rất nhiều với ReSharper và một điều tôi muốn thiết lập cho nhóm của mình là các thông báo nếu một lớp C# hoặc tệp C# không có tiêu chuẩn nhận xét mã được đặt. Đáng tiếc là tôi chưa thể tìm thấy nhiều về chủ đề này.

Ví dụ, tôi muốn chắc chắn rằng tất cả các phương pháp hoặc các chức năng có một mô tả bình luận ở trên chúng:

/// <summary> 
/// Description of MyMethod here. 
/// </summary> 
public void MyMethod(); 

Tôi muốn cũng để thấy rằng một tấm séc cơ bản cho dù (Số dòng mã)/(Số dòng bình luận) là xung quanh một số phép thuật hạnh phúc trung bình, và tạo ra một thông báo hoặc cảnh báo nếu không.

Answer 1

Một tùy chọn đơn giản để bắt đầu (thậm chí không cần R #) là bật tính năng tạo tệp tài liệu XML và sau đó xử lý cảnh báo dưới dạng lỗi. Điều đó sẽ đảm bảo rằng mỗi thành viên công khai đều có tài liệu.

Nó sẽ không đảm bảo rằng các nhận xét là tốt, tất nhiên ... nhưng nó sẽ đảm bảo chúng tồn tại.

EDIT: R # hiện có cài đặt cho điều này - dưới Kiểm tra mã, Kiểm tra mức độ nghiêm trọng, C#, Cảnh báo biên dịch, tìm CS1591: Missing XML comment for publicly visible type or member (và cảnh báo liên quan gần nó). Thay đổi mức độ nghiêm trọng của lỗi đó thành Lỗi và có thể giúp bạn - nhưng thật khó để nói là bạn đang ở trong một môi trường bất thường.

Answer 2

Không được cạnh tranh với Jon nhưng GhostDoc thực hiện những gì bạn mô tả.

Answer 3

Ngoài ra, hãy kiểm tra StyleCop trong đó có một plugin Resharper, có nghĩa là bình luận thiếu (đối với phương pháp, tài sản, vv) sẽ được hiển thị như Resharper cảnh báo/lỗi. Có thể, hoặc có thể không, được bạn quan tâm, nhưng ít nhất đó là một lựa chọn.

Answer 4

Stylecop có nhiều quy tắc cho nhận xét, bạn cũng có thể muốn xem Stylecop+ vì điều này có một số quy tắc bổ sung cho Phương thức/Độ dài thuộc tính.

Answer 5

Có hai tùy chọn. Cả hai - sử dụng các phần mở rộng cho ReSharper - không phải cho Visual Studio (nếu bạn không biết, ReSharper có Trình quản lý mở rộng của riêng nó). Những phần mở rộng là (sử dụng một giây!):

1. AgentSmith (cho R 9 #). Bây giờ, ReSharper's Extension Manager cho biết, phần mở rộng này dành cho ReSharper của phiên bản 9.0 (mà tôi đã cài đặt) nhưng, trên thực tế, phần mở rộng này hoạt động với các lỗi (vô hiệu hóa các điểm nổi bật hoạt động không đúng).

2. Kiểm tra tài liệu XML cho ReSharper 9. Có vẻ, công trình mà không có bất kỳ vấn đề (tôi có nó chỉ cần cài đặt). Đó là những gì bạn thực sự cần để làm nổi bật các lớp học, phương pháp, tài sản và vv (thậm chí cả các lĩnh vực tư nhân) mà không có ý kiến ​​XML!