Cet article explique comment un analyseur Roslyn peut vous aider à déboguer et à améliorer la qualité de votre code de jeu dans Unity.
Un analyseur Roslyn est un outil d'analyse de code qui utilise les API de la plateforme de compilateur Roslyn pour analyser le code C# en temps réel. Un analyseur peut fournir des suggestions d'amélioration du code, des avertissements ou des erreurs basés sur un ensemble de règles prédéfinies. Il fonctionne comme un plug-in pour Microsoft Visual Studio et Microsoft Visual Studio Code, complétant les fonctionnalités IntelliSense de ces deux éditeurs de code.
Les analyseurs Roslyn s'appuient sur les suggestions, les compléments et les informations sur les API disponibles fournies par IntelliSense avec des outils supplémentaires pour analyser et identifier les problèmes potentiels dans votre code. De plus, vous recevrez des suggestions de correctifs possibles à l'aide des API d'une plate-forme de compilateur Roslyn.
Les analyseurs Roslyn sont utiles pour faire respecter les normes et vous avertir si vous enfreignez une convention de code. De plus, ils peuvent souvent aider à corriger ces erreurs de code ou ces violations de style.
Visual Studio est livré avec de nombreux analyseurs par défaut qui font partie du référentiel Open Source pour Roslyn et constituent une bonne ressource pour en savoir plus sur le débogage avec cette méthode.
remarque La majeure partie de cet article s'applique uniquement à Windows. Les analyseurs Roslyn peuvent également être utilisés avec Visual Studio pour macOS, mais la prise en charge de leur inspection est limitée par rapport à celle disponible pour Windows.
L'image ci-dessus provient d'une vidéo qui montre une utilisation typique d'un analyseur Roslyn. Dans cet exemple, une analyse du code a repéré une variable inutilisée. Le développeur est informé de ce problème car le nombre de variables est souligné par un gribouilli vert. En cliquant dessus, vous affichez le problème et un lien avec des options pour le résoudre. Dans la vidéo, le développeur choisit de supprimer la variable inutilisée en fonction de la recommandation.
En plus d'un gribouillis vert, vous pouvez voir un gribouillis rouge ou des points gris. Ces différents symboles indiquent le niveau de sécurité du problème ou la gravité du problème pour votre code.
Comme le montre le tableau ci-dessus, chaque analyseur possède un niveau de gravitéconfigurable par l'utilisateur.
Il existe plusieurs analyseurs Roslyn disponibles, mais Visual Studio en est également livré avec certains préinstallés. Vous pouvez ajuster les paramètres de ces analyseurs intégrés à deux endroits. Pour votre version locale de Visual Studio, les paramètres par défaut sont ajustés via Tools > Options > Text Editor > C# > Code Style > General. Vous pouvez modifier le niveau de gravité à l'aide de la boîte de dialogue affichée dans l'image ci-dessus.
L'image ci-dessus est celle d'une classe de code simple. Le symbole de points de suspension (trois points sur une ligne) sous les lettres p et o en pos à la ligne 7 et l'instruction if à la ligne 11 indiquent une suggestion. Le gribouillis vert sous la distance est un avertissement, et le gribouillis rouge sous les deux instances de xPos sur la ligne 11 est une erreur. Les avertissements et les erreurs apparaîtront également dans la fenêtre Liste des erreurs.
Vous remarquerez que l'image montrant les paramètres des analyseurs intégrés bascule entre Refactoring uniquement et la suggestion de Préférences de bloc de code : Préférer un appareil dentaire. La refactorisation masquerait uniquement les points de suspension sous l'instruction if.
Si le paramètre Préférer les accolades est une suggestion et que vous survolez les points de suspension, vous verrez un panneau affichant un liende correctifs potentiels . En cliquant dessus, vous affichez un autre panneau avec les options disponibles. Dans ce cas, une seule option est disponible : ajouter des accolades au code. L'image ci-dessus montre cette séquence.
Si vous souhaitez garantir le style de code pour un projet spécifique, vous pouvez ajouter un fichier .editorconfig fourni avec le projet. Cela peut constituer un moyen efficace d’appliquer des règles de style de code convenues au sein d’une équipe plus large composée de nombreux développeurs.
Un fichier .editconfig vous permet de remplacer les paramètres de votre version de Visual Studio via Tools > Options > Text Editor > C#. Vous pouvez même imbriquer plusieurs fichiers .editorconfig si nécessaire en en plaçant un à la racine et un dans un sous-dossier. Celui du sous-dossier remplacera alors celui de la racine.
Les sections suivantes expliquent comment ajouter un fichier .editorconfig.
Modifiez le niveau de gravité d'un analyseur inclus dans une fenêtre de texte de code.
Cliquez avec le bouton droit sur l'Explorateur de solutions et choisissez Nouvel élément. Dans le panneau suivant, choisissez Installé > C# > Fichier de configuration général de l'éditeur (par défaut).
Une autre option consiste à sélectionner le fichier Générer .editorconfig à partir des paramètres du panneau Outils > Options > Éditeur de texte > C# (comme le montre l'image sous Configurer les analyseurs intégrés).
Maintenant que vous disposez d'un fichier .editorconfig, Visual Studio (version Windows) affiche une vue modifiable du fichier texte sous le capot. Les modifications apportées à ce fichier affecteront les scripts C# dans le dossier où le .editorconfig est enregistré et tous les sous-dossiers.
Vous pouvez étendre les fonctionnalités en ajoutant des analyseurs Roslyn préinstallés. Les analyseurs sont installés sous forme de packages NuGet ou d'extensions Visual Studio (fichiers VSIX). Accédez à www.nuget.org pour le processus d'installation du package NuGet. L'un des plus populaires est StyleCop.Analyzers, qui recherche les problèmes de style dans votre base de code.
Installez le package dans Visual Studio à l'aide de la console du gestionnaire de packages via Tools > NuGet Package Manager > Package Manager Console. La page www.nuget.org de chaque package d'analyseur vous montre la commande à coller dans la console du gestionnaire de packages. Il existe même un bouton pratique pour copier le texte dans le presse-papiers.
Les assemblys d'analyseur sont installés et apparaissent dans l'Explorateur de solutions sous References > Analyzers.
Une autre option consiste à installer des analyseurs fournis sous forme d'extensions VSIX. Dans Visual Studio, sélectionnez Extensions > Gérer les extensions.
Si vous connaissez le nom de l'extension, utilisez le champ de recherche pour la trouver ou recherchez simplement « analyseur ». L'image ci-dessus montre l'analyseur de commentaires sélectionné. Cliquez sur Télécharger pour installer l'extension de l'analyseur, sélectionnez OK pour fermer la boîte de dialogue et fermez toutes les instances de Visual Studio pour lancer le programme d'installation VSIX.
Sélectionnez Modifier pour démarrer l'installation. Une fois l'installation terminée, sélectionnez Fermer et rouvrez Visual Studio.
Si vous souhaitez vérifier si l'extension est installée, sélectionnez Extensions > Gérer les extensions. Dans la boîte de dialogue Gérer les extensions, sélectionnez la catégorie Installé sur la gauche, puis recherchez l'extension par son nom.
Cet article s'est concentré sur les analyseurs Roslyn intégrés disponibles avec Visual Studio, mais vous pouvez également créer les vôtres. Les analyseurs créés à l'aide de la plateforme .NET Compiler peuvent améliorer considérablement la qualité du code de votre équipe.
Au fur et à mesure que vous deviendrez expérimenté dans la création d'analyseurs, vous remarquerez comment ils aident votre équipe à devenir plus productive avec des problèmes de codage tels que la syntaxe, les modifications répétitives, le guidage avec une nouvelle bibliothèque, etc.
Quelques bonnes ressources supplémentaires de Microsoft incluent ce didacticiel sur la façon de créer votre propre analyseur C# Roslyn et cette vidéo YouTube sur les analyseurs Roslyn.
Le débogage dans Unity
Obtenez plus de conseils sur le débogage de votre projet Unity à partir de ces articles :
E-books techniques avancés
Unity fournit un certain nombre de guides avancés pour aider les développeurs professionnels à optimiser le code du jeu. Créez un guide de style C# : Écrivez un code plus propre et évolutif compile les conseils d'experts du secteur sur la façon de créer un guide de style de code pour aider votre équipe à développer une base de code propre, lisible et évolutive.
Un autre guide populaire auprès de nos utilisateurs contient plus de 70 conseils pour augmenter la productivité avec Unity. Il regorge de conseils qui vous feront gagner du temps pour améliorer votre flux de travail global quotidien avec Unity 2020 LTS – des conseils que même les développeurs expérimentés auraient pu manquer.
Retrouvez tous les livres électroniques et articles avancés de Unity dans le hub des meilleures pratiques Unity.