Bonnes pratiques relatives à la gestion des scripts
L’objectif de cet article est de partager des bonnes pratiques relatives la gestion des scripts dans Planisware.
Cet article se concentre sur l’agencement général des scripts et ne traite pas des règles de nommage ou des bonnes pratiques concernant le code en lui-même.
Ces bonnes pratiques sont issues de mon expérience et de celle de mes collègues. Elles ont pour but de :
→ Retrouver rapidement les modifications effectuées dans une version.
→ Eviter de perdre du temps lors du développement.
→ Lire et comprendre plus rapidement les scripts.
1. Le versionning
Le versionning d’un script est obligatoire afin de tracer les modifications effectuées. Il permet de réduire drastiquement le temps d’analyse lorsque ce que l’on cherche a été modifié à une date ou dans une version connue. Il est beaucoup plus simple de se pencher sur les dernières modifications effectuées que de revoir entièrement une fonction, voir l’intégralité du script.
2. Le détail des révisions
Le détail des révisions (en haut de chaque script) comprenant la modification effectuée avec la référence de la spécification, de ticket, d’incident (un ID ou un numéro) est une bonne pratique essentielle pour gagner du temps. Il est également intéressant de mettre aussi la date et l’heure de modification ainsi que le nom du développeur. Cela peut permettre d’identifier rapidement la personne à l’origine de la modification.C’est pratique quand on est plusieurs à développer ou que l’on souhaite obtenir des explications sur une modification apportée.
3. Le commentary des fonctions
Chacune des fonctions présentes dans le script doit être commentée. Ce commentaire doit définir fonctionnellement à quoi sert la fonction.
3.2. Le commentary des modifications faites sur les fonctions
Il est conseillé, lors de la modification des fonctions suite à des évolutions demandées par le client ou tout simplement des corrections de fonctionnalité, de laisser un commentaire avant la modification de code avec le n° de ticket, la date de modification et le nom de l’auteur.
4. L’affichage du chargement du script dans la console
Il est recommandé d’afficher le nom du script dans la console planisware. Cela permet de vérifier que le script en question est bien chargé au démarrage. Pour cela il faut tout simplement utiliser l’instruction writeln.
Exemple : writeln(\ »Script loaded $Revision: 3.01 $\ »); »
Ici cela permettra de tracer dans le log du démarrage que le script à bien été évalué au démarrage et qu’il s’agit de la version 3.01.
5. Conclusion et synthèse.
