8.5 Règles de documentation et design d’un VI

Au moment où il créé une application, le développeur a à l’esprit la manière dont celui-ci est structuré, pourquoi certains choix sont faits, etc. Mais qu’en sera-t-il dans quelques mois ? Que se passe-t-il si quelqu’un d’autre doit apporter des modifications à l’application ?

Lorsque vous réalisez un programme, cherchez à obtenir des diagrammes lisibles. Le diagramme ne devrait ne pas dépasser la taille d'un écran, et le programme se lire naturellement de gauche à droite et de haut en bas.

Les commentaires (étiquettes libres) sont les bienvenus. Expliquez succinctement les choix qui ont été faits. Aérez votre diagramme, évitez les angles et pelotes de fils, cherchez la lisibilité, la maintenance n'en sera que plus facile.

Créez des sous-programmes pour les fonctions spécialisées, ou appelées de manière répétée. Chercher la modularité (un sous-VI fait une seule chose, et le fait bien). Pour des modules comportant plusieurs VIs, réalisez l’interface avec le programme à partir d’un seul VI du module.

Vous pouvez utiliser la fonction de nettoyage automatique du diagramme (ctrl-U) (que l’on peut paramétrer dans les options de LabVIEW). Le résultat n’est pas toujours bien probant, surtout sur des grands diagrammes. Le nettoyage peut se faire sur la totalité du diagramme ou sur une partie sélectionnée avec la souris.

La première manière de documenter un VI réside dans son écriture lisible : entrées à gauche, sorties à droite, diagramme clair, flux de données lisible, icône représentative de la fonctionnalité d’un VI.

On pourra compléter cette auto-documentation avec les outils suivants :

• Sous-titre, descriptions et infobulles pour les objets de face avant
• Décorations et commentaires libres, coté FA ou diagramme
• Description du VI (CTL -I) et des modifications (CTL-Y)