Nagłówek dokumentacji StyleCop XML - Używanie 3 /// zamiast 2 //

Question

Używam nagłówków dokumentacji XML w moich plikach C#, aby przekazać regułę StyleCop SA1633.

Obecnie muszę użyć reguły komentowania 2 slashów, aby umożliwić StyleCopowi rozpoznanie nagłówka. na przykład:

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

Działa to dobrze dla StyleCop, jednak chciałbym użyć reguły komentowania 3 ukośnik włączyć visual studio zrozumieć komentarze jak XML i zapewnić funkcjonalność XML (podkreślając, auto wcięcia itp)

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

Problem polega na tym, że przy użyciu 3 ukośników, StyleCop nie widzi już nagłówka i zgłasza ostrzeżenie SA1633.

Czy mimo to należy skonfigurować stylecop, aby zrozumieć, że nagłówek jest zawarty w języku XML za pomocą 3 ukośników?

Dzięki,

Adam

Answer 1

Można zbudować regułę niestandardową i wyłączyć oryginalny za swój nowy: http://scottwhite.blogspot.com/2008/11/creating-custom-stylecop-rules-in-c.html