Vous trouverez ci-dessous des informations supplémentaires sur l'en-tête Documentation utilisée dans une procédure stockée :
Balises
Le script récupère les lignes qui commencent par : -- DID -
Il s'agit de l'identifiant par lequel une ligne de documentation doit commencer. Ce sigle est l'abréviation de 'Data Integration Documentation'. Il doit être suivi d'un indicateur mentionnant ce qui est documenté dans la ligne. La longueur maximum de la ligne entière ne doit pas dépasser 200 caractères, et ce afin d'éviter que le contenu soit tronqué.
Les balises peuvent être répétées plusieurs fois. Le contenu sera ensuite concaténé dans le script sur la base de la séquence dans laquelle il se produit dans la routine.
Les balises ne doivent pas être définies à un emplacement précis de la routine. Elles peuvent apparaître n'importe où dans le script. Évitez cependant de définir des balises au-dessus de la partie 'CREATE/ALTER' d'une procédure stockée. Le système a en effet des difficultés à lire la procédure stockée lorsqu'elle est enregistrée dans Selligent.
Les éléments suivants sont actuellement récupérés :
Author
Définit l'auteur du script original.
Exemple : -- DID - Author : Peggy Heyvaert
CreationDate
Doit contenir la date de création originale de la routine.
Exemple : -- DID - CreationDate : 2017-02-28
Version
Indique la version du script. Nous respectons le schéma de version 'X.Y.Z' :
- Les numéros de version majeure changent dès qu'une modification importante ou sans retour en arrière potentiel est apportée à un logiciel.
- Les numéros de version mineure changent pour refléter l'introduction d'une nouvelle fonctionnalité mineure ou le lancement d'un ensemble de fonctionnalités mineures.
- Le numéro de correctif change lorsqu'une nouvelle version du logiciel est lancée pour les clients. C'est le cas notamment lorsqu'un bogue mineur est résolu (ou cas similaire).
Si une routine n'est pas encore utilisée en production, le numéro de version majeure doit être '0'. Dès qu'elle est utilisée en production, il passe à '1'.
Exemple : -- DID - Version : 1.2.3
Description
Contient la description de la routine. Soyez aussi précis que possible afin de définir clairement ce que la routine fera, sans qu'il y ait besoin de lire le code.
Exemple : -- DID - Description : Fonction qui permet de mettre en majuscule le premier caractère de chaque mot de la chaîne d'entrée passée.
Exceptions
Si la routine peut déclencher une ou plusieurs erreurs spécifiques, ces dernières doivent être définies dans cet élément. Si plusieurs erreurs sont déclenchées explicitement par les applications, elles doivent chacune être placées sur une nouvelle ligne.
Exemple :
-- DID - Exceptions : Fiche introuvable.
-- DID - Exceptions : Fiche expirée.
BusinessRules
Toutes les règles opérationnelles spécifiques doivent être définies dans cet élément. Vous pouvez définir plusieurs règles opérationnelles en répétant simplement la partie 'DID'. Cet élément n'étant pas limité à l'en-tête, vous pouvez l'utiliser partout dans votre routine. Vous pouvez donc l'utiliser de manière extensive pour documenter différentes parties de la routine.
Exemple :
-- DID - BusinessRules : Vérifie si la fiche ne se produit qu'une seule fois dans la liste.
-- DID - BusinessRules : Vérifie si la fiche est toujours active.
LastModifiedBy
Doit contenir le nom de la personne qui a modifié la routine en dernier lieu.
Exemple : -- DID - LastModifiedBy : Hermans Oliver
