StyleCop documentazione XML Intestazione - Utilizzando 3 /// invece di 2 //
-
20-09-2019 - |
Domanda
Sono utilizzando le intestazioni di documentazione XML sul mio file C # per passare la regola StyleCop SA1633.
Al momento, devo usare la regola commentando 2 barra per consentire StyleCop di riconoscere l'intestazione. per esempio:
// <copyright file="abc.ascx.cs" company="MyCompany.com">
// MyCompany.com. All rights reserved.
// </copyright>
// <author>Me</author>
Questo funziona bene per StyleCop, però mi piacerebbe utilizzare la regola commentando 3 barra per consentire lo studio visivo di comprendere i commenti come XML e forniscono le funzionalità XML (evidenziando, auto indentazione etc)
/// <copyright file="abc.ascx.cs" company="MyCompany.com">
/// MyCompany.com. All rights reserved.
/// </copyright>
/// <author>Me</author>
Il problema è che quando si utilizza 3 barre, StyleCop più a vedere è l'intestazione e lancia l'avvertimento SA1633.
Esiste un modo per configurare StyleCop per capire l'intestazione è contenuto in XML utilizzando 3 barre?
Soluzione
Si potrebbe costruire una regola personalizzata e disabilitare l'originale in favore di quello nuovo: http://scottwhite.blogspot.com/2008 /11/creating-custom-stylecop-rules-in-c.html