Bonnes pratiques de style et

documentation
Importance de la documentation du code

 En pratique, un programme évolue toujours

 Pas le même programmeur, pas le même état d’esprit
 Votre code doit être lisible et documenté
 Checklist pour le style de programmation
 https://www.ni.com/docs/fr-FR/bundle/labview/page/lvdevconcepts/checklist.ht
ml
Que fait ce code ?
 Etiquettes de sous-diagramme
Plus clair comme ça ?

Etiquette libre Etiquettes des fils de

Noms et icones liaison et des constantes
plus clairs
Créer une étiquette libre (commentaire)
 Pour créer une étiquette libre, double-cliquez simplement sur le diagramme

Etiquette sur fil de liaison

Documenter un sous-diagramme

 Clic droit sur la structure -> Eléments visibles -> Etiquette de sous-diagramme
 Fonctionne pour les structures séquence, condition, boucle, événement, …

 Options de LabVIEW :
en faire le comportement
par défaut
Choisir des noms pour les entrées/sorties des sous-VI

 Différent types d’entrées

nécessaire,
recommandée, ou
optionnelle
 Parenthèse = valeur par défaut ou unité
Exemple : Booléen Transposer le tableau (F)
Tension à appliquer (V)
 Utiliser le même nom pour les sorties répliquant les entrées
Exemple : Entrée d’erreur -> Sortie d’erreur
Nom de fichier en entrée -> Nom de fichier en sortie
 Les commandes/indicateurs ont une propriété documentation
Description : apparait dans l’aide contextuelle sur le diagramme
Info-bulle : apparait lorsque l’on lance le programme (utilisateur)
Documenter le VI (fenêtre d’aide contextuelle)

 Fichier -> Propriétés du VI (Ctrl+I) puis aller dans catégorie Documentation

Imprimer la documentation

 Fichier -> Imprimer

 Utile pour faire un fichier d’aide
 Permet de vérifier que vous avez suffisamment documenté
 Eléments imprimables
Face avant, icone et connecteur
Diagramme et sous-diagrammes non visibles (ex : condition Vrai/Faux)
Commandes et leur description
…
Exercice : documenter un projet

 Ouvrir le projet Bitmap file writer.lvproj

 Exécuter le VI
Tester la zone de dessin qui apparaît
Enregistrer le fichier puis ouvrez-le avec un autre programme
 En ouvrant le diagramme, on s’aperçoit que l’essentiel du fonctionnement vient du
sous-VI Drawing Pad, construit sur une structure événement.
Documenter les sous-diagrammes de cette structure événement.
Documenter la description des sous-VI LabVIEW Coordinates to Picture
Coordinates.vi et Picture to 2-D Color Array.vi. Vérifiez dans l’aide contextuelle
que la documentation apparaît.
Plus généralement, insérer des étiquettes libres, des étiquettes des fils de liaison, la
description des commandes de la face avant, …
Essayer la fonctionnalité d’impression des Vis.
 On attend que les Vis finaux de vos projets soient correctement documentés !