Visual Studio est un environnement de développement intégré (IDE) puissant qui propose un éventail d’outils destinés à faciliter le travail des développeurs. Parmi ces outils se trouve Code Cleanup, une fonctionnalité essentielle pour améliorer la qualité, la lisibilité et la cohérence du code. Dans cet article, nous allons explorer en détail cette fonctionnalité, ses avantages et son utilisation.

Click here for English version

Qu’est-ce que Code Cleanup ?

Code Cleanup est une fonctionnalité intégrée dans Visual Studio qui permet aux développeurs de nettoyer et standardiser automatiquement leur code en suivant des règles prédéfinies. Elle identifie et corrige des problèmes communs tels que :

• La suppression des espaces inutiles.
• Le formatage des indentations.
• L’ajout des directives using nécessaires.
• L’application des conventions de nommage.
• La suppression des variables ou méthodes inutilisées.

Code Cleanup s’appuie sur les analyzers de Visual Studio et les paramètres définis dans les fichiers de configuration comme .editorconfig pour effectuer les ajustements automatiquement.

Pourquoi utiliser Code Cleanup ?

Voici quelques bénéfices majeurs de l’utilisation de Code Cleanup :

1. Gain de Temps : En automatisant des tâches répétitives, vous économisez des heures de nettoyage manuel.
2. Qualité du Code : Votre code devient plus propre, lisible et conforme aux conventions de votre équipe.
3. Collaboration Simplifiée : Le respect des standards facilite la revue du code et réduit les conflits lors des intégrations.
4. Réduction des Erreurs : En éliminant les incohérences et les petits défauts, Code Cleanup contribue à la stabilité de vos applications.

Comment utiliser Code Cleanup dans Visual Studio ?

Voici un guide pas-à-pas pour tirer le meilleur parti de cette fonctionnalité :

• Configurer les Règles : Accédez aux options via Tools > Options > Text Editor > Code Cleanup ou en cliquant sur l’icone de la balayette en bas comme ci dessous :

Configurez vos préférences en fonction des conventions de votre projet. Pour mon exemple, je vais utiliser le Profile 2 pour rajouter quelques règles de bonnes pratiques comme ci dessous :

J’ai donc définie comme règles de supprimer les variables non utilisées, d’indenter proprement les fichiers, de trier et supprimer les Usings non nécessaires, et de fixer tous les avertissements et erreurs définis dans mon fichier editorconfig.

• Exécuter et Vérifier : Lancez Code Cleanup sur le fichier ou le projet entier en sélectionnant le profile adéquate (pour mon exemple c’est le Profile 2). Ci dessous un exemple de fichier qui n’a pas était encore nettoyé :

Et ci dessous le résultat du Code Clean :

• Automatisation avec .editorconfig : Ajoutez un fichier .editorconfig à votre projet pour définir des règles spécifiques de formatage. Visual Studio respectera ces paramètres lors de l’exécution de Code Cleanup.

Astuces et Bonnes Pratiques

• Utilisez les Profils Personnalisés : Configurez plusieurs profils de Code Cleanup pour différents types de projets ou étapes de développement.
• Intégrez Code Cleanup dans vos Pipelines CI/CD : Certaines tâches de nettoyage peuvent être automatisées grâce à des outils tiers comme Roslyn Analyzers.
• Revoyez régulièrement les Règles : Adaptez vos règles de formatage en fonction des évolutions des besoins de votre équipe.

Conclusion

La fonctionnalité Code Cleanup de Visual Studio est un allié incontournable pour tout développeur souhaitant produire un code de qualité. Facile à utiliser, elle réduit la charge de travail liée au nettoyage manuel et garantit la conformité aux standards établis. Que vous soyez débutant ou expert, tirer parti de Code Cleanup améliorera votre productivité et la qualité de vos projets.

Happy coffee coding