2010-03-17 3 views
19

Tôi đang sử dụng tiêu đề tài liệu XML trên các tệp C# của tôi để chuyển quy tắc StyleCop SA1633.Tiêu đề tài liệu XML StyleCop - Sử dụng 3 /// thay vì 2 //

Hiện tại, tôi phải sử dụng quy tắc nhận xét cắt giảm 2 để cho phép StyleCop nhận ra tiêu đề. ví dụ:

// <copyright file="abc.ascx.cs" company="MyCompany.com"> 
//  MyCompany.com. All rights reserved. 
// </copyright> 
// <author>Me</author> 

này hoạt động tốt cho StyleCop, tuy nhiên tôi muốn sử dụng 3 dấu gạch chéo quy tắc cho ý kiến ​​để cho phép visual studio để hiểu những ý kiến ​​như XML và cung cấp các chức năng XML (làm nổi bật, tự động thụt vv)

/// <copyright file="abc.ascx.cs" company="MyCompany.com"> 
///  MyCompany.com. All rights reserved. 
/// </copyright> 
/// <author>Me</author> 

Vấn đề là khi sử dụng 3 dấu gạch chéo, StyleCop không còn thấy tiêu đề và ném cảnh báo SA1633.

Có cách nào để định cấu hình stylecop để hiểu tiêu đề được chứa trong XML bằng 3 dấu gạch chéo không?

Cảm ơn,

Adam

+0

Tôi đã chỉ có thể tìm thấy những tài liệu về định dạng của tiêu đề và cách định cấu hình các phần tử bên trong tiêu đề, chứ không phải định dạng của nhận xét. – ChrisF

Trả lời

12

Bạn có thể xây dựng một quy tắc tùy chỉnh và vô hiệu hóa các gốc ủng hộ của bạn mới: http://scottwhite.blogspot.com/2008/11/creating-custom-stylecop-rules-in-c.html

+2

Cảm ơn Leom, tôi nghĩ rằng đây sẽ là giải pháp, nó sẽ là tốt đẹp để mở rộng hoặc sao chép mã cho quy tắc SA1633 hơn là viết lại nó. –

+0

Có ai đã viết thành công quy tắc mới cho điều này chưa? Không cảm thấy như tái tạo bánh xe. –