Écrivez un meilleur code plus rapidement avec les analyseurs Roslyn

Roslyn, la plate-forme du compilateur .NET, vous aide à détecter les bogues avant même d'exécuter votre code. Un exemple est l'analyseur de vérification orthographique de Roslyn intégré à Visual Studio. Supposons que vous créez une méthode statique et que vous avez mal orthographié le mot statique en tant que statc . Vous pourrez voir cette erreur d'orthographe avant d'exécuter votre code, car Roslyn peut générer des avertissements dans votre code pendant que vous tapez avant même d'avoir terminé la ligne. En d'autres termes, vous n'avez pas besoin de créer votre code pour savoir que vous avez fait une erreur.



Les analyseurs Roslyn peuvent également détecter un correctif de code automatique via l'icône de l'ampoule Visual Studio qui vous permet de corriger votre code immédiatement.

Et si vous pouviez attraper encore plus de bugs?

Permettez-moi de vous présenter les packages d'analyseurs Roslyn. Ces collections d'analyseurs fournissent une analyse plus détaillée, mais ne sont pas fournies avec les outils Visual Studio par défaut. Pour en savoir plus sur nos analyseurs Roslyn préférés, visitez notre référentiel GitHub des analyseurs Roslyn . Ce référentiel comprend les règles FxCop qui sont toujours applicables au développement de logiciels modernes, mais ciblent désormais notre plate-forme d'analyse de code moderne basée sur Roslyn. Allons de l'avant et installons ce package pour être plus productif et écrire un meilleur code plus rapidement!

Pour installer des analyseurs FxCop en tant que package NuGet:

1. En supposant que vous utilisez Visual Studio 2017 version 15.8 ou plus récente, choisissez la version la plus récente de Microsoft.CodeAnalysis.FxCopAnalyzers .
2. Installez le package dans Visual Studio, à l'aide de l' interface utilisateur du gestionnaire de packages .

Une fois le package installé, vous pouvez simplement personnaliser les diagnostics de l'analyseur à partir de l'Explorateur de solutions. Un nœud d'analyseur apparaîtra sous le nœud Références ou dépendances dans l'Explorateur de solutions. Si vous développez les analyseurs, puis développez l'un des ensembles d'analyseurs, vous pouvez voir tous les diagnostics dans l'ensemble.



Vous pouvez afficher les propriétés d'un diagnostic, y compris sa description et sa gravité par défaut, dans la fenêtre des propriétés. Pour afficher les propriétés, cliquez avec le bouton droit sur la règle et sélectionnez Propriétés, ou sélectionnez la règle, puis appuyez sur Alt + Entrée.



Les icônes à côté de chaque diagnostic dans l'Explorateur de solutions correspondent aux icônes que vous voyez dans le jeu de règles lorsque vous l'ouvrez dans l'éditeur:

• le "i" dans un cercle indique une gravité d'Info
• le "!" dans un triangle indique une gravité d'avertissement
• le "x" dans un cercle indique une gravité d'erreur
• le "i" dans un cercle sur un fond de couleur claire indique une gravité de Hidden
• le "↓" dans un cercle indique un diagnostic supprimé

Vous pouvez ensuite définir la gravité de l'ensemble de règles à partir de l'Explorateur de solutions. Dans l'Explorateur de solutions, développez Dépendances> Analyseurs. Développez l'assembly qui contient la règle pour laquelle vous souhaitez définir la gravité. Cliquez avec le bouton droit sur la règle et sélectionnez Définir la gravité du jeu de règles et dans le menu déroulant, sélectionnez l'une des options de gravité.



Si vous définissez la gravité de la règle sur un avertissement, vous recevrez alors un avertissement dans votre code pour cet ensemble de règles spécifique.



Maintenant que vous comprenez comment fonctionnent les analyseurs, vous pouvez être plus productif et écrire un meilleur code plus rapidement!

FAQ:

Q: Cet avertissement apparaît dans Visual Studio: «Exécuter l'analyse de code a été déconseillé au profit des analyseurs FxCop, qui s'exécutent pendant la génération. Reportez-vous à https://aka.ms/fxcopanalyzers pour migrer vers les analyseurs FxCop. " Qu'est-ce que cela signifie?

R: FxCop est le moteur d'analyse de code qui précède Roslyn de près d'une décennie. Tout comme nous avons fait avancer notre compilateur (par exemple, introduit Roslyn), nous déplaçons également notre technologie d'analyse de code vers la plate-forme Roslyn. Puisqu'il est alimenté par la plate-forme du compilateur .NET, il peut générer des avertissements dans votre code lors de la frappe. En d'autres termes, vous n'avez pas besoin de créer votre code pour savoir que vous avez fait une erreur.

Q: Quelle est la différence entre les analyseurs FxCop et les anciens FxCop?

R: Les analyseurs FxCop analysent le code source en temps réel et pendant la compilation, tandis que FxCop hérité est une analyse de code statique et analyse les fichiers binaires une fois la construction terminée. Pour plus d'informations, voir Analyseurs Roslyn vs. FAQ sur l' analyse de code statique et les analyseurs FxCop .

Q: Puis-je écrire des analyseurs personnalisés?

R: Absolument! La documentation sur la façon d'écrire un analyseur se trouve ici.

Q: Dois-je utiliser des analyseurs Roslyn ou .editorconfig pour le style de code?

R: Les analyseurs Roslyn et les fichiers .editorconfig fonctionnent main dans la main. Lorsque vous définissez des styles de code dans un fichier .editorconfig ou sur la page d' options de l'éditeur de texte , vous configurez en fait les analyseurs Roslyn intégrés à Visual Studio.

Q: Les analyseurs fonctionnent-ils dans les builds d'intégration continue (CI)?

R: Oui, les analyseurs installés en tant que packages NuGet peuvent être appliqués dans les builds CI.

Q: Où puis-je demander plus d'analyseurs ou signaler des bogues?

R: Vous pouvez demander plus d'analyseur et signaler des bogues sur le référentiel Roslyn sur GitHub.