Débogage des add-ins SOLIDWORKS : le guide du développeur

Martin Bartolomé
Application Engineer chez Visiativ Switzerland

Dans le domaine du développement logiciel, en particulier pour les applications complexes comme les add-ins SOLIDWORKS, le débogage est indispensable. Il permet aux développeurs de trouver et de corriger les erreurs et les problèmes existants dans leur code. Sans techniques de débogage efficaces, de petites erreurs non résolues peuvent entraîner de gros problèmes dans le logiciel, ce qui peut conduire à un flux de travail inefficace et à la frustration des utilisateurs. Ici sera vu, comment déboguer des add-ins SOLIDWORKS à l’aide d’outils disponibles sous Microsoft Visual Studio.

Le débogage dans la programmation C# pour les add-ins SOLIDWORKS commence par préparer des points d’arrêt du code à des endroits stratégiques ou précédents le lancement de l’erreur. Cela inclut l’insertion de points d’arrêt qui vous permettent d’arrêter l’exécution du programme à un moment donné et d’inspecter l’état de l’application. Visual Studio, l’environnement de développement privilégié des développeurs C#, offre de puissants outils de débogage qui permettent d’examiner les valeurs des variables, de parcourir le code pas à pas et de surveiller le comportement des appels et des exceptions.

Lors du débogage des add-ins SOLIDWORKS, vous devez accorder une attention particulière à l’interaction entre votre code et l’API SOLIDWORKS. Surveillez de près les appels à l’API pour vous assurer que vous recevez les données et les objets attendus et qu’ils sont correctement manipulés. Gardez un œil sur les performances, car un code inefficace peut entraîner des retards qui nuisent à l’expérience utilisateur.

En outre, la journalisation est un aspect important du débogage. En enregistrant les événements clés et les valeurs pendant l’exécution, vous pouvez suivre les problèmes qui peuvent être occasionnels et qui ne sont pas visibles pendant une session de débogage normale.

En appliquant ces techniques, vous pouvez identifier et résoudre la plupart des problèmes dans votre add-in SOLIDWORKS. La clé d’un débogage réussi est la patience et une approche systématique pour s’assurer qu’aucune erreur n’est oubliée. Ici ces différentes techniques seront présentées.

La première étape consiste à définir des points d’arrêt. Ces petits marqueurs dans le code indiquent au débogueur qu’il doit arrêter l’exécution à ce point. Dans les add-ins SOLIDWORKS complexes, vous les placez à des endroits critiques ou là où vous pensez qu’il y a une erreur.

Dans Visual Studio, cliquez à gauche du numéro de ligne dans l’éditeur de code pour définir un point d’arrêt. Une icône rouge indique qu’un point d’arrêt est actif à cet endroit. Vous pouvez également définir des points d’arrêt pendant l’exécution afin de réagir de manière dynamique aux changements de comportement du code.

Commencez le débogage en lançant l’add-in dans l’environnement de débogage. Le programme s’arrêtera aux points d’arrêt définis et vous pourrez inspecter les valeurs des variables.

Démarrez le débogage en cliquant sur “Start Debugging” ou en appuyant sur F5. Le programme sera exécuté jusqu’à ce qu’il atteigne un point d’arrêt ou qu’une exception se produise.

Lorsque le code s’arrête à un point d’arrêt, vérifiez l’état de l’application. Examinez les variables locales, la pile d’appels et les valeurs des paramètres d’objets qui sont pertinents pour l’exécution en cours.

Lorsqu’un point d’arrêt est atteint, Visual Studio ouvre automatiquement une fenêtre qui affiche les valeurs actuelles des variables dans le contexte local. Vous pouvez également utiliser les onglets ” Autos ” et ” Local “ pour avoir une vision plus approfondie de l’état actuel du programme.

Utiliser les fonctions enjamber (‘step-over’), entrer (‘step-into’) et sortir (‘step-out’) du débogueur pour parcourir le code ligne par ligne. Cela permet d’observer précisément comment les variables se modifient par rapport au flux du programme.

• F10 (Step Over) permet de pour passer au-dessus d’une fonction sans l’exécuter et de passer à la fonction suivante
• F11 (Step Into) permet d’entrer dans une fonction,
• Shift+F11 (Step Out) permet de sortir d’une fonction sans l’exécuter et de retourner à la fonction l’ayant appelée.

Ajoutez des expressions ou des variables à la fenêtre de surveillance afin de garder un œil sur leurs valeurs au fur et à mesure que vous progressez dans le code. Cela est particulièrement utile pour suivre l’évolution des objets qui affectent l’API SOLIDWORKS.

Ajoutez des variables ou des expressions dans la fenêtre Watch en saisissant le nom de la variable ou en faisant glisser l’expression directement dans la fenêtre. La fenêtre se met à jour à chaque étape que vous effectuez et affiche les valeurs actuelles.

Configurez le débogueur pour qu’il s’arrête sur les exceptions, même si elles sont interceptées. Cela vous permet de voir des erreurs qui pourraient autrement être masquées par des routines de gestion des erreurs.

Sous “Debug” > “Windows” > “Exception Settings”, vous pouvez définir des exceptions spécifiques pour lesquelles le débogueur doit s’arrêter. Vous pouvez surveiller toutes les exceptions ou sélectionner des types d’exceptions spécifiques.

Lisez les informations de sortie de la console afin de mieux comprendre ce qui s’est passé avant et après l’arrêt du débogueur. Cela peut se faire en examinant les sorties dans la fenêtre “Output” ou dans des fichiers log externes. Il est possible de rediriger les flux de sortie standard et d’erreur dans des fichiers différents.

Chaque processus est associé à 3 flux au démarrage identiques à ceux existants en C :

• un flux d’entrée standard – Console.In
• un flux de sortie standard – Console.Out
• un flux d’erreur standard – Console.Error

Par défaut, la fenêtre “Output” de Visual Studio affiche la sortie standard et d’erreurs de votre programme. Vous pouvez y voir les informations des sorties qui sont émises par Console.WriteLine ou d’autres mécanismes de logging.

Parfois, les erreurs ne se produisent que dans certaines conditions. Les points d’arrêt conditionnels peuvent être définis de manière qu’ils ne soient actifs que si une certaine condition est vraie.

1. Pour définir un point d’arrêt conditionnel :
2. cliquez avec le bouton droit de la souris sur un point d’arrêt défini
3. sélectionnez “Conditions”
4. Saisissez une condition qui doit être remplie pour que le point d’arrêt soit actif.

Utilisez les outils de diagnostic de Visual Studio pour surveiller l’impact des modifications du code sur les performances de l’add-in. De longs temps d’exécution des fonctions ou une consommation élevée de mémoire peuvent indiquer des problèmes.

Visual Studio propose des “outils de diagnostic” qui peuvent être ouverts automatiquement pendant une session de débogage. Vous pouvez y surveiller l’utilisation du CPU et la consommation de mémoire.
Vous trouverez cette option sous “Debug” > “Windows” > “Show Diagnostic Tools”.

Le débogage est une compétence critique dans le développement de logiciels, qui permet aux développeurs de trouver l’origine des erreurs et de les corriger. Dans le contexte des add-ins SOLIDWORK, un débogage efficace peut faire la différence entre un add-in réussi et un add-in défectueux.