Comment créer vos règles StyleCop

StyleCop est un outil gratuit de Microsoft permettant de vérifier le style de votre code (ou celui des autres). De plus, StyleCop est maintenant offert en Open Source (sur Codeplex), donc je vous conseille fortement de regarder l’implémentation des règles par défaut pour vous aider à créer les vôtres.

Créer vos règles

Voici quelques étapes pour créer vos règles personnalisées StyleCop:

  • Installer la dernière version de StyleCop
  • Télécharger le SDK de StyleCop (fichier .chm de documentation)
  • Démarrer Visual Studio
  • Créer un nouveau projet de type “Class Library”
  • Ajouter les références suivantes
    • Microsoft.StyleCop
    • Microsoft.StyleCop.CSharp
    • Microsoft.StyleCop.CSharp.Rules

StyleCop_SolutionExplorer

Débogage

Puisque les règles de StyleCop sont dans le répertoire de celui-ci et que StyleCop est intégré à Visual Studio, voici quelques configuration pour vous aider (Changer les répertoires au besoin):

  • Dans les propriétés du projet/Build Events :
    • Post-build event command line: xcopy "$(TargetDir)BHRules*.*" "C:\Program Files\Microsoft StyleCop 4.3.3.0" /y
  • Dans les propriétés du projet/Debug:
    • Start external program: C:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE\devenv.exe
    • Command line arguments (optionnel): Chemin d’une solution que vous désirez valider avec vos nouvelles règles.

Si vous avez des questions, utiliser les commentaires ou via le formulaire de contact.