Suppression StyleCop

Question

Est-il possible de supprimer les règles StyleCop d'une manière plus globale ... en d'autres termes, en n'utilisant pas uniquement les attributs en ligne source?

Answer 1

Vous pouvez désactiver certaines règles stylecop avec un fichier Settings.StyleCop. Par exemple, il y a certaines choses dans stylecop qui ne correspondent pas à notre standard. Par exemple, dans mon fichier Settings.StyleCop nous avons:

<Analyzer AnalyzerId="Microsoft.StyleCop.CSharp.ReadabilityRules"> 
    <Rules> 
    <Rule Name="PrefixLocalCallsWithThis"> 
     <RuleSettings> 
     <BooleanProperty Name="Enabled">False</BooleanProperty> 
     </RuleSettings> 
    </Rule> 
    </Rules> 
    <AnalyzerSettings /> 
</Analyzer> 

telle que sur une variable membre ou bien nous ne pas avoir « cela. » pour chacun d'eux.

Answer 2

Absolument!

Les attributs de la source ne doivent être utilisés que dans de très rares circonstances, la grande majorité de votre configuration StyleCop doit être effectuée via StyleCopSettingsEditor (cliquez avec le bouton droit de la souris sur un projet, choisissez "Paramètres StyleCop") .

Cela créera un fichier Settings.StyleCop pour ce projet dans le répertoire du projet. Ce fichier peut être édité à la main comme le mentionne l'autre réponse, mais je ne suggérerais jamais de pirater XML dans un éditeur. StyleCopSettingsEditor est définitivement le chemin à parcourir.

Une fois que vous avez modifié vos paramètres StyleCop, vous n'avez pas terminé!
Ces paramètres ne s'appliqueront qu'à ce projet, et cela pourrait certainement être insuffisant.
Je suggère personnellement de déplacer ce fichier StyleCop.Settings d'un répertoire au niveau de la solution et de l'ajouter en tant que "Solution Item". Ensuite, vérifiez ce fichier dans TFS (ou quel que soit le système de contrôle de la source que vous utilisez). Maintenant, ces paramètres StyleCop font partie de la solution complète, et tout le monde les obtiendra quand ils feront un "Get Latest". Si nécessaire, vous pouvez remplacer les paramètres de la solution par les paramètres du projet (un fichier StyleCop.Settings au niveau du projet en remplacera un au niveau de la solution). La seule façon de rendre vos paramètres StyleCop plus globaux est de les déplacer encore plus haut dans l'arborescence de répertoires (jusqu'au niveau du projet d'équipe si vous utilisez TFS, pas fiable car faire un GetLatest à la solution level ne les distribuera pas à tout le monde), ou pour remplacer le fichier Settings.StyleCop dans le répertoire d'installation de StyleCop (encore moins fiable car cela ne peut pas être géré par le contrôle source et doit être envoyé à tout le monde). Dans l'ensemble, il y a certainement des façons de rendre les paramètres StyleCop spécifiques pour votre équipe aussi globale que vous le souhaitez, vous avez beaucoup d'options.