Tutoriel : Apprendre à déboguer le code C# avec Visual Studio

Cet article présente les fonctionnalités du débogueur Visual Studio dans une procédure pas à pas. Pour un tour d’horizon plus général des fonctionnalités du débogueur, voir Présentation du débogueur. Lorsque vous déboguez votre application, cela signifie généralement que vous exécutez votre application avec le débogueur attaché. Lorsque vous effectuez cette tâche, le débogueur fournit de nombreuses façons de voir ce que fait votre code pendant qu’il s’exécute. Vous pouvez parcourir votre code pas à pas et examiner les valeurs stockées dans les variables, vous pouvez définir des espions sur des variables pour voir quand les valeurs changent, vous pouvez examiner le chemin d’exécution de votre code, voir si une branche de code s’exécute, etc. Si, avec cet exercice, c’est la première fois que vous essayez de déboguer du code, vous pouvez lire Débogage pour grands débutants avant de poursuivre cet article.

Bien que l’application de démonstration soit en C#, la plupart des fonctionnalités s’appliquent à C++, Visual Basic, F#, Python, JavaScript et les autres langages pris en charge par Visual Studio (F# ne prend pas en charge Edit-and-continue). F# et JavaScript ne prennent pas en charge la fenêtre Automatique). Les captures d’écran sont en C#.

Ce didacticiel présente les procédures suivantes :

• Démarrer le débogueur et atteindre des points d’arrêt
• Découvrir les commandes permettant de parcourir le code pas à pas dans le débogueur
• Inspecter des variables dans des bulles d’informations et dans les fenêtres du débogueur
• Examiner la pile des appels

Prérequis

Visual Studio 2022 et la charge de travail Développement .NET Desktop doivent être installés.

Si vous n’avez pas encore installé Visual Studio, accédez à la page Téléchargements Visual Studio pour l’installer gratuitement.

Si vous disposez déjà de Visual Studio, mais que la charge de travail Développement .NET Desktop n’est pas installée, accédez à Outils>Obtenir des outils et des fonctionnalités..., ce qui lance Visual Studio Installer. Dans Visual Studio Installer, choisissez la charge de travail Développement .NET Desktop, puis Modifier.

Créer un projet

Tout d’abord, vous créez un projet d’application console .NET Core. Le type de projet inclut tous les fichiers de modèle dont vous avez besoin au départ.

1. Ouvrez Visual Studio. Si la fenêtre de démarrage n’est pas ouverte, sélectionnez Fichier>Fenêtre Démarrer.

2. Dans la fenêtre de démarrage, sélectionnez Créer un projet.

3. Dans la fenêtre Créer un projet, entrez console dans la zone de recherche. Ensuite, choisissez C# Dans la liste des langages, puis choisissez Windows dans la liste des plateformes.

   Une fois que vous avez appliqué les filtres de langage et de plateforme, choisissez le modèle Application console, puis sélectionnez Suivant.

   

   Remarque

   Si vous ne voyez pas le modèle Application console, vous pouvez l’installer à partir de la fenêtre Créer un projet. Dans le Vous ne trouvez pas ce que vous cherchez ?, choisissez le lien Installer plus d’outils et de fonctionnalités. Dans le Visual Studio Installer, choisissez ensuite la charge de travail Développement de bureau .NET.

4. Dans la fenêtre Configurer votre nouveau projet, entrez GetStartedDebugging dans la zone Nom du projet. Sélectionnez ensuite Suivant.

5. Dans la fenêtre Informations supplémentaires, vérifiez que .NET 8.0 est sélectionné dans le menu déroulant Framework, puis sélectionnez Créer.

Visual Studio ouvre votre nouveau projet.

Création de l'application

Dans Program.cs, remplacez tout le code par défaut par le code suivant :

using System;

class ArrayExample
{
   static void Main()
   {
      char[] letters = { 'f', 'r', 'e', 'd', ' ', 's', 'm', 'i', 't', 'h'};
      string name = "";
      int[] a = new int[10];
      for (int i = 0; i < letters.Length; i++)
      {
         name += letters[i];
         a[i] = i + 1;
         SendMessage(name, a[i]);
      }
      Console.ReadKey();
   }

   static void SendMessage(string name, int msg)
   {
      Console.WriteLine("Hello, " + name + "! Count to " + msg);
   }
}

Démarrez le débogueur !

La plupart du temps, nous utilisons des raccourcis clavier ici, car il s’agit d’un moyen rapide d’exécuter des commandes du débogueur. Des commandes équivalentes, telles que des commandes de la barre d’outils ou de menu, sont également indiquées.

1. Pour démarrer le débogueur, sélectionnez F5 ou choisissez le bouton Cible de débogage dans la barre d’outils Standard, ou choisissez le bouton Démarrer le débogage dans la barre d’outils Déboguer, ou choisissez Déboguer>Démarrer le débogage dans la barre de menus.

   

   F5 démarre l’application avec le débogueur attaché au processus d’application. Étant donné que nous n’avons rien fait de spécial pour examiner le code, l’application s’exécute jusqu’à l’achèvement et vous voyez la sortie de la console.

   Hello, f! Count to 1
   Hello, fr! Count to 2
   Hello, fre! Count to 3
   Hello, fred! Count to 4
   Hello, fred ! Count to 5
   Hello, fred s! Count to 6
   Hello, fred sm! Count to 7
   Hello, fred smi! Count to 8
   Hello, fred smit! Count to 9
   Hello, fred smith! Count to 10
   

2. Pour arrêter le débogueur, sélectionnez Maj+F5, ou choisissez le bouton Arrêter le débogage dans la barre d’outils Déboguer, ou choisissez Déboguer>Arrêter le débogage dans la barre de menus.

   

3. Dans la fenêtre de console, sélectionnez une touche pour fermer la fenêtre de console.

Définir un point d’arrêt et démarrer le débogueur

1. Dans la boucle for de la fonction Main, définissez un point d’arrêt en cliquant dans la marge gauche de la ligne de code suivante :

   name += letters[i];

   Un cercle rouge apparaît là où vous avez défini le point d’arrêt.

   

   Les points d’arrêt constituent une fonctionnalité essentielle pour un débogage fiable. Vous pouvez définir des points d’arrêt là où vous voulez que Visual Studio interrompe l’exécution de votre code afin d’examiner les valeurs des variables ou le comportement de la mémoire ou encore la bonne exécution ou non d’une branche de code.

2. Pour commencer le débogage, sélectionnez F5 ou choisissez le bouton Cible de débogage dans la barre d’outils Standard, ou choisissez le bouton Démarrer le débogage dans la barre d’outils Déboguer, ou choisissez Déboguer>Démarrer le débogage dans la barre de menus. L’application démarre et le débogueur s’exécute jusqu’à la ligne de code où vous avez défini le point d’arrêt.

   

   La flèche jaune pointe vers l’instruction sur laquelle le débogueur s’est arrêté. L’exécution de l’application est suspendue au même point, l’instruction n’étant pas encore exécutée.

   Lorsque l’application n’est pas en cours d’exécution, F5 démarre le débogueur, qui s’exécute jusqu’à ce qu’il atteigne le premier point d’arrêt. Si l’application est suspendue à un point d’arrêt, F5 continue d’exécuter l’application jusqu’à ce qu’elle atteigne le point d’arrêt suivant.

   Les points d’arrêt sont une fonctionnalité pratique quand vous savez quelle ligne ou section de code vous voulez examiner en détail. Pour plus d’informations sur les différents types de points d’arrêt que vous pouvez définir, tels que les points d’arrêt conditionnels, consultez Utilisation des points d’arrêt.

Naviguer dans le code et inspecter les données à l’aide de conseils sur les données

1. L’exécution du code étant interrompue sur l’instruction name += letters[i], pointez sur la variable letters pour afficher une bulle d’informations montrant la taille du tableau et le type d’élément, char[10].

   Remarque

   L’une des fonctionnalités les plus utiles du débogueur est sa capacité à inspecter une variable. Souvent, quand vous essayez de déboguer un problème, vous essayez de déterminer si les variables ont les valeurs que vous attendez à un moment donné. L’affichage des conseils sur les données est un bon moyen de vérifier cela.

2. Développez la variable letters pour afficher tous ses éléments de tableau et leurs valeurs.

   

3. Pointez sur la variable name pour afficher sa valeur actuelle, qui est une chaîne vide.

4. Pour faire avancer le débogueur jusqu’à l’instruction suivante, sélectionnez F10, ou cliquez sur le bouton Pas à pas principal dans la barre d’outils Déboguer, ou choisissez Déboguer>Pas à pas principal dans la barre de menus. Sélectionnez F10 deux fois de plus pour passer l’appel de méthode SendMessage.

   F10 fait avancer le débogueur sans effectuer de pas à pas détaillé dans les fonctions ou les méthodes, mais leur code s’exécute néanmoins. De cette façon, nous avons ignoré le débogage du code dans la méthode SendMessage, qui ne nous intéresse pas pour l’instant.

5. Pour itérer dans la boucle for plusieurs fois, sélectionnez F10 à plusieurs reprises. Pendant chaque itération de boucle, effectuez une pause au point d’arrêt, puis pointez sur la variable name pour vérifier sa valeur dans l’info-bulle de données.

   

   La valeur de la variable change à chaque itération de la boucle for, en affichant les valeurs de f, puis fr, puis fre, et ainsi de suite. Pour faire avancer le débogueur dans la boucle plus rapidement, sélectionnez plutôt F5, qui progresse jusqu’à votre point d’arrêt au lieu de l’instruction suivante.

6. L’exécution du code étant interrompue dans la boucle for de la méthode Main, sélectionnez F11, ou choisissez le bouton Effectuer un pas à pas détaillé dans la barre d’outils Déboguer, ou choisissez Déboguer>Effectuer un pas à pas détaillé dans la barre de menu, jusqu’à ce que vous atteigniez l’appel de méthode SendMessage.

   Le débogueur doit être suspendu à cette ligne de code :

   SendMessage(name, a[i]);

7. Pour effectuer un pas à pas détaillé dans la méthode SendMessage, sélectionnez de nouveau F11.

   Le pointeur jaune avance dans la méthode SendMessage.

   

   F11 vous aide à examiner plus en détail le flux d’exécution de votre code. Pour effectuer un pas à pas détaillé dans une méthode à partir d’un appel de méthode, sélectionnez F11. Par défaut, le débogueur ignore le pas à pas détaillé dans les méthodes non-utilisateur. Pour en savoir plus sur le débogage du code non-utilisateur, consultez Uniquement mon code.

   Une fois que vous avez terminé le débogage de la méthode SendMessage, vous êtes prêt à revenir à la boucle for de la méthode main.

8. Pour quitter la méthode SendMessage, sélectionnez Maj+F11, ou cliquez sur le bouton Pas à pas sortant dans la barre d’outils Déboguer, ou choisissez Déboguer>Pas à pas sortant dans la barre de menus.

   La commande Pas à pas sortant reprend l’exécution de l’application et fait avancer le débogueur jusqu’au retour de la méthode ou fonction active.

   Vous voyez le pointeur jaune de retour dans la boucle for de la méthode Main, interrompue à l’appel de méthode SendMessage. Pour plus d’informations sur les différentes façons de vous déplacer dans votre code, consultez Parcourir le code dans le débogueur.

Parcourir le code avec Exécuter jusqu’au clic

1. Sélectionnez F5 pour passer à nouveau au point d’arrêt.

2. Dans l’éditeur de code, pointez sur l’appel de méthode Console.WriteLine dans la méthode SendMessage jusqu’à ce que le bouton Exécuter jusqu’au clic apparaisse. L’info-bulle du bouton indique « Lancer l’exécution jusqu’ici. »

   

3. Sélectionnez le bouton Exécuter jusqu’au clic. Sinon, avec votre curseur au niveau de l’instruction Console.WriteLine, sélectionnez Ctrl+F10. Vous pouvez également cliquer avec le bouton droit sur l’appel de méthode Console.WriteLine, puis choisir Exécuter jusqu’au curseur dans le menu contextuel.

   Le débogueur avance jusqu’à l’appel de méthode Console.WriteLine.

   L’utilisation du bouton Exécuter jusqu’au clic est similaire à la définition d’un point d’arrêt temporaire. Cela permet de se déplacer rapidement dans une zone visible du code de votre application dans un fichier ouvert.

Redémarrer rapidement votre application

Pour réexécuter votre application depuis le début dans le débogueur, sélectionnez Ctrl+Maj+F5, ou choisissez le bouton Redémarrer dans la barre d’outils Déboguer, ou choisissez Déboguer>Redémarrer dans la barre de menus.

La commande Redémarrer arrête le débogueur, puis le redémarre en une seule étape. Lorsque le débogueur redémarre, il s’exécute jusqu’au premier point d’arrêt, qui est le point d’arrêt que vous avez précédemment défini dans la boucle for, puis s’interrompt.

Inspecter des variables avec les Fenêtres Automatique et Variables locales

Les fenêtres Autos et Locals affichent les valeurs des variables lorsque vous déboguez. Les fenêtres ne sont disponibles que pendant une session de débogage. La fenêtre Autos affiche les variables utilisées sur la ligne active à laquelle se trouve le débogueur et sur la ligne précédente. La fenêtre Locals affiche les variables définies dans l’étendue locale, qui est généralement la fonction ou la méthode actuelle.

1. Pendant que le débogueur est suspendu, consultez la fenêtre Autos en bas de l’éditeur de code.

   Si la fenêtre Autos est fermée, sélectionnez Ctrl+D, A ou choisissez Déboguer>Fenêtres>Autos dans la barre de menus.

2. Pendant que le débogueur est toujours suspendu, consultez la fenêtre Locals, dans un onglet à côté de la fenêtre Autos.

   Si la fenêtre Locals est fermée, sélectionnez Ctrl+D, L ou choisissez Déboguer>Fenêtres>Locals.

3. Dans la fenêtre Locals, développez la variable letters pour voir ses éléments de tableau et leurs valeurs.

   

Pour plus d’informations sur les fenêtres Autos et Locals, consultez Inspecter les variables dans les fenêtres Autos et Locals.

Définir un espion

Vous pouvez spécifier une variable, ou une expression, sur laquelle vous souhaitez garder un œil lorsque vous parcourez le code, en l’ajoutant à la fenêtre Espion.

1. Pendant que le débogueur est suspendu, cliquez avec le bouton droit sur la variable name et choisissez Ajouter un espion.

   La fenêtre Espion s’ouvre par défaut en bas de l’éditeur de code.

2. Maintenant que vous avez défini un espion sur la variable name, parcourez votre code pour voir la valeur de la variable name changer à chaque itération de la boucle for.

   Contrairement à d’autres fenêtres de variables, la fenêtre Espion présente toujours les variables que vous observez. Les variables hors de l’étendue sont affichées comme indisponibles.

Pour plus d’informations sur la fenêtre Espion, consultez Observer des variables avec les fenêtres Espion.

Examiner la pile des appels

La pile des appels peut vous aider à comprendre le flux d’exécution de votre application, en montrant l’ordre dans lequel les méthodes et les fonctions sont appelées.

1. Pendant que le débogueur est suspendu dans la boucle for, consultez la fenêtre Pile des appels, qui s’ouvre par défaut dans le volet inférieur droit de l’éditeur de code.

   Si la fenêtre Pile des appels est fermée, sélectionnez Ctrl+D, C ou choisissez Déboguer>Fenêtres>Pile des appels dans la barre de menus.

   Dans la fenêtre Pile des appels, vous voyez le pointeur jaune au niveau de la méthode Main active.

2. Sélectionnez F11 plusieurs fois, jusqu’à ce que le débogueur place l’application en pause dans la méthode SendMessage.

   La ligne supérieure de la fenêtre Pile des appels affiche la fonction active, qui est la méthode SendMessage. La deuxième ligne montre que la méthode SendMessage a été appelée à partir de la méthode Main.

   

   Note

   La fenêtre Pile des appels est similaire à la perspective Débogage dans certains IDE, comme Eclipse.

   Dans la fenêtre Pile des appels, vous pouvez double-cliquer sur une ligne de code pour accéder à ce code source, ce qui change également l’étendue active inspectée par le débogueur. Cette action ne fait pas avancer le débogueur.

   Vous pouvez également utiliser les menus contextuels de la fenêtre Pile des appels pour faire d’autres choses. Par exemple, vous pouvez insérer des points d’arrêt dans des fonctions spécifiées, faire avancer le débogueur avec Exécuter jusqu’au curseur ou examiner le code source.

Pour plus d’informations sur la pile des appels, consultez Guide pratique pour examiner la pile des appels.

Changer le flux d’exécution

Vous pouvez déplacer le pointeur d’exécution pour modifier le flux de votre application lors du débogage.

1. Lorsque le débogueur est suspendu au niveau de l’appel de méthode SendMessage dans la boucle for, sélectionnez F11 trois fois pour effectuer un pas à pas détaillé dans la méthode SendMessage et passer la méthode Console.WriteLine après l’avoir exécutée.

   Le débogueur est maintenant suspendu à l’accolade de fermeture finale de la méthode SendMessage.

2. Utilisez la souris pour sélectionner la flèche jaune ou le pointeur d’exécution (dans la marge gauche), puis faites glisser le pointeur d’une ligne vers le haut.

   Le débogueur est maintenant de retour sur l’instruction Console.WriteLine.

3. Sélectionnez F11.

   Le débogueur réexécute la méthode Console.WriteLine et vous voyez une ligne en double dans la sortie de la fenêtre de console.

4. Sélectionnez F5 pour poursuivre l’exécution de l’application.

En changeant le flux d’exécution, vous pouvez effectuer des opérations comme tester d’autres chemins d’exécution du code ou réexécuter du code sans devoir redémarrer le débogueur.

Avertissement

Utilisez cette fonctionnalité avec précaution. Vous verrez un avertissement dans l’info-bulle du pointeur d’exécution concernant la possibilité de conséquences inattendues. D’autres avertissements peuvent également s’afficher. Le fait de déplacer le pointeur d’exécution ne peut pas rétablir votre application à un état antérieur.

Pour plus d’informations sur la modification du flux d’exécution, consultez Déplacer le pointeur pour modifier le flux d’exécution.

Félicitations ! Vous avez terminé ce didacticiel.

Étapes suivantes

Dans ce tutoriel, vous avez découvert comment démarrer le débogueur, parcourir le code pas à pas et inspecter des variables. Vous pouvez obtenir une présentation générale des fonctionnalités du débogueur et suivre des liens qui donnent accès à plus d’informations.

Présentation du débogueur