le 02-28-2014 04:05 PM
Salut, pour faire simple ( !)
Le minimum : La documentation « diagramme » et « face-avant » doit être conforme au LabVIEW style Checlklist
http://zone.ni.com/reference/en-XX/help/371361J-01/lvdevconcepts/checklist/
La structure de ton main doit être plus documentée. Identifier les process, tu as 2 boucles, la méthode de communication entre les process. Définir le design pattern si connu. Documenter les états de ta strucutre event, afin de comprendre par la lecture, le pourquoi de la fonction, sans interpréter par la lecture LabVIEW du code.
L’aide contextuelle, CTRL+H, est documentée. Elle explique la finalité du vi, afin de l’utiliser comme une « boite noire », sans à avoir à "lire" le code LabVIEW.
Le diagramme d’un vi, donc à destination d’un développeur, doit être commenté pour les besoins d’un développeur pour être lisible, avec au moins un commentaire développeur par vi.
L’exemple de framework de NI livré avec LabVIEW est vraiment un excellent exemple de documentation de structure d’application. Aide contextuelle des vi’s, description dans le diagramme et aide html du projet
A+
Luc Desruelle | Mon profil | Mon blog LabVIEW | Auteur livre LabVIEW : Programmation et applications - G Web
Certified LabVIEW Architect (CLA) & Certified TestStand Developper (CTD) | LabVIEW Champion
MESULOG - LinkedIn site | NERYS - NERYS Group
| directeur CEO MESULOG
| CODIR - NERYS group
le 02-28-2014 08:37 PM
oups !
ça fait 20 ans que je programme en total autodidacte et uniquement "pour moi même".
(beaucoup beaucoup d'assembleur dans une vie précédente)
J'intégrerais une "équipe" de développement ... c'est sur ce point que je me ferais "avoir", y'a pas photo !
(mais bon ... intégrer une équipe ... à moins d'en être le boss ... je ne vois pas trop )
Ne pas documenter est un gros défaut, même pour moi-même.
Il m'est arrivé plus d'une fois, 6 mois plus tard, de ne plus rien comprendre à un de mes codes.
Surtout que je suis un accro d'optimisation ... et un code fortement optimisé (surtout en assembleur) devient vite un code crypté !
Bon ...
on va essayer d'améliorer la chose.
Merci Luc.
petit commentaire qui ne sert à rien :
je suis "tombé" sur le code du jeu d'échecs en Labview (chess.dll) ici
Le gars qui a pondu ça est un malin ... mais sur l'implémentation en elle-même ... il y a 1000 choses à améliorer.
En d'autres termes, l'algorithme est plutôt pas mal ... mais le code n'est pas top (du tout)
Je suis en train de "décoder" l'ensemble du code et de recoder tout ça ... "à ma façon".
Tout ça pour dire quoi ? ... pour dire qu'il n'y a quasi aucune doc ni commentaires.
il faut suivre le code à la trace, step by step. (un boulot de dingue ... mais quel plaisir !)
Ce serait chouette d'ajouter à ce jeu d'échecs (passif) ... un petit moteur de réflexion (pas Deep-Blue bien entendu)