Fonctionnalités des audits et des métriques

De Appmethod Topics
Aller à : navigation, rechercher

Remonter à Audits et métriques du code source

Les audits et les métriques du code source vous aident à respecter et à appliquer les conventions et les standards de votre société, à capturer les métriques réelles et à améliorer votre travail.

Vous pouvez appliquer :

  • Les audits aux projets Object Pascal et C++.
    Remarque : Appmethod C++ ne prend pas en charge les audits à iOS 64 bits.
  • Les métriques aux projets Object Pascal.

Comme avec les fonctionnalités de tout contrôle de qualité (QA, Quality Assurance), pour travailler avec les audits et les métriques du code source, vous devez comprendre ce qui est mesuré et pourquoi. Bien que les audits et les métriques sont similaires dans le sens où ils analysent votre code source, ils répondent à différents besoins. Les audits et les métriques sont exécutés dans des processus distincts. Puisque les résultats de ces deux processus sont différents par nature, les audits et les métriques du code source proposent des fonctionnalités différentes pour l'interprétation et l'organisation des résultats.

Avertissement : Les audits et les métriques ne sont pas disponibles pour les projets de conception.

La vidéo Audits DCC in Object Pascal 2010, par Mike Rozlog (EN) montre comment utiliser les audits pour trouver du code dupliqué.

Audits

Vous pouvez exécuter les audits de code source dans les projets Object Pascal et C++.

Quand vous exécutez des audits, vous pouvez sélectionner des audits spécifiques (règles) auxquels votre code source doit se conformer. Vous pouvez sélectionner l'ensemble d'audits à exécuter dans la boîte de dialogue Audits du contrôle qualité pour les projets Object Pascal et dans la boîte de dialogue Audits du contrôle qualité C++ pour les projets C++. Les résultats du traitement des audits affichent seulement les violations de ces règles, ce qui vous permet d'examiner chaque problème et de décider s'il faut corriger le code source. Vous pouvez choisir parmi une large gamme d'audits. La portée des audits disponibles va des problèmes de conception aux conventions de nommage. Les descriptions indiquent ce que chaque audit recherche et la façon de corriger les violations. Voir les listes des audits disponibles pour les projets Object Pascal dans la boîte de dialogue Audits du contrôle qualité, et pour les projets C++ dans Audits C++.

Métriques

Vous pouvez exécuter les métriques de code source seulement dans les projets Object Pascal.

Les métriques évaluent la complexité des modèles d'objets et quantifient votre code. Il vous incombe ensuite d'étudier les résultats des métriques et de décider s'ils sont acceptables. Les résultats des métriques peuvent mettre en surbrillance des parties de code devant être reconçues ou permettre de créer des rapports et de comparer l'impact global des modifications d'un projet. Avec l'ensemble de métriques, la fonctionnalité Métriques propose des astuces sur l'utilisation des métriques et l'interprétation des résultats. La fonctionnalité Métriques supporte une large gamme de métriques. Voir les descriptions des métriques disponibles dans la boîte de dialogue Métriques du contrôle qualité.

Les résultats des métriques peuvent aussi être affichés sous forme de graphiques. Deux vues graphiques vous permettent de récapituler les résultats des métriques : histogrammes et graphes de Kiviat. Ces deux vues graphiques sont invoquées depuis le menu contextuel du tableau Résultats des métriques.

Histogrammes

Utilisez les histogrammes pour les colonnes du volet Métriques.

L'histogramme affiche les valeurs d'une métrique sélectionnée pour tous les packages, classes et/ou opérations.

La couleur des barres reflète la conformité aux valeurs limites de la métrique de référence :

  • Le vert représente des valeurs situées dans la limite permise.
  • Le rouge représente les valeurs dépassant la limite supérieure.
  • Le bleu représente les valeurs inférieures à la valeur minimale permise.
  • Une mince ligne rouge verticale représente la limite supérieure permise et une mince ligne bleue verticale représente la limite inférieure permise.

Graphes de Kiviat

Utilisez les graphes de Kiviat pour les lignes du volet Métriques.

Le graphe de Kiviat présente les résultats d'analyse de la classe ou du package actuellement sélectionné pour toutes les métriques ayant des limites permises prédéfinies pour les valeurs. Les résultats des métriques apparaissent le long des axes qui partent du centre du graphe.

Chaque axe a une échelle logarithmique avec la base logarithmique étant la limite supérieure des métriques. Par conséquent, toutes les valeurs de limites supérieures sont équidistantes du centre. Ainsi, les limites et les valeurs sont affichées avec la notation suivante :

  • Les limites supérieures sont représentées par un cercle rouge. Tous les points situés à l'extérieur du cercle rouge violent la limite supérieure.
  • Les limites inférieures sont représentées par une zone bleue, tous les points situés à l'intérieur de cette zone violent la limite inférieure. Notez que cette zone bleue n'apparaît pas dans les zones du graphe dont les limites inférieures sont définies à 1 ou 0.

Quand le curseur de la souris passe au-dessus du graphe, un conseil s'ouvre. Il affiche des informations sur la métrique ou sur la valeur de la métrique sous le curseur.

Les graphes de Kiviat utilisent les éléments graphiques suivants :

  • Une métrique réelle est présentée sous la forme d'une étoile, avec la valeur de la métrique représentée par un point.
  • Les points verts représentent les valeurs acceptables.
  • Les points bleus représentent les valeurs sous les limites inférieures.
  • Les points rouges représentent les valeurs dépassant les limites supérieures.
  • Les graphes affichent les marques d'échelle sous la forme de traits situés dans le sens des aiguilles d'une montre et perpendiculaires au rayon Kiviat.
  • Les graphes affichent les libellés de limites inférieures sous la forme de traits bleus situés dans le sens inverse des aiguilles d'une montre et perpendiculaires au rayon Kiviat.

Ensembles d'audits et de métriques actifs

Les boîtes de dialogue Audits du contrôle qualité et Métriques du contrôle qualité affichent les ensembles de tous les audits et métriques disponibles.

Quand vous ouvrez un projet, les ensembles par défaut d'audits et de métriques sont actifs. Les audits et les métriques sont indiqués par des coches dans la boîte de dialogue Audits du contrôle qualité et Métriques du contrôle qualité. Si vous ouvrez la boîte de dialogue Audits du contrôle qualité ou Métriques du contrôle qualité et cliquez sur Démarrer, tous les audits ou métriques actifs sont traités.

Si vous ne voulez pas traiter chaque audit ou métrique de l'ensemble par défaut à chaque fois, vous pouvez créer et enregistrer (dans des fichiers) des ensembles personnalisés d'audits et de métriques actifs (seulement dans les projets Object Pascal). Les ensembles enregistrés peuvent être chargés (depuis des fichiers) et traités à votre guise. Utilisez les boutons Enregistrer l'ensemble d'audits et Charger l'ensemble d'audits des barres d'outils des boîtes de dialogue Audits du contrôle qualité et Métriques du contrôle qualité.

Vous pouvez toujours restaurer les ensembles d'audits et de métriques actifs par défaut en utilisant les boutons Définir l'ensemble d'audits ou de métriques par défaut.

Voir aussi