AUTHOR |
Auteur |
|---|---|
| Cobol | |
Syntaxe
| AUTHOR. [comment-entry] ... |
Paramètres
| Nom | Description |
|---|---|
| comment-entry | Ce paramètre permet d'indiquer le nom de l'auteur. |
Description
Cette instruction permet de définir l'auteur du programme COBOL.
Remarques
- AUTHOR est une clause documentaire, sans impact sur l'exécution : L'instruction AUTHOR. est utilisée uniquement à des fins de documentation. Elle n'a aucun effet sur l'exécution du programme COBOL. Elle permet toutefois d'identifier clairement qui est l'auteur du programme ou du module, ce qui facilite le suivi, la maintenance, et la gestion des versions dans les projets à long terme.
- Elle fait partie de la division IDENTIFICATION : L'instruction AUTHOR appartient à la division IDENTIFICATION DIVISION, regroupent les métadonnées du programme. Elle est généralement placée juste après PROGRAM-ID, et avant d'autres clauses comme INSTALLATION, DATE-WRITTEN, ou REMARKS. Cela reflète l'organisation rigoureuse et normalisée des programmes COBOL.
- Le paramètre comment-entry est libre mais souvent normé : Le paramètre comment-entry permet d'indiquer le nom de l'auteur du programme. Il peut s'agir d'un nom personnel, d'un identifiant interne ou d'un nom d'équipe. Dans les environnements professionnels, il est souvent accompagné de la date, du matricule de l'auteur, voire de l'équipe ou du service pour respecter les conventions de codage internes.
- Bonne pratique : inclure les coordonnées ou un commentaire utile : Bien que COBOL n'impose pas de format spécifique à AUTHOR, il est recommandé d'ajouter plus qu'un simple nom. Par exemple :
- Utilisation dans les audits et la maintenance : La clause AUTHOR est souvent utilisée dans les contextes réglementés ou critiques (banques, assurances, industrie). Elle contribue à la traçabilité du code, un aspect essentiel lors des audits qualité ou des revues de conformité. Même si elle ne joue aucun rôle technique, sa valeur documentaire est très élevée.
- Aucune obligation d'unicité ou de contenu fixe : Il n'est pas obligatoire que le nom inscrit après AUTHOR soit unique. Il peut être répété dans plusieurs programmes, ce qui est courant quand une même personne développe plusieurs modules. Le langage ne vérifie pas le contenu : AUTHOR. accepte tout texte libre, du moment qu'il est sur la même ligne ou dans une continuation valide.
- Complémentarité avec d'autres clauses de métadonnées : La clause AUTHOR est souvent utilisée en conjonction avec DATE-WRITTEN, DATE-COMPILED, ou SECURITY. Ensemble, ces instructions forment un en-tête descriptif qui résume l'origine, l'historique et parfois la confidentialité du programme. Cela aide à contextualiser le code pour un relecteur ou un nouvel arrivant dans l'équipe.
- Utile pour les générateurs de documentation automatique : Dans certains outils de gestion de code source ou de génération de documentation, les informations issues de l'IDENTIFICATION DIVISION, dont AUTHOR, sont extraites automatiquement. Ces données sont ensuite utilisées pour créer des rapports ou des fichiers de suivi, notamment dans les systèmes de gestion de versions ou d'intégration continue.
AUTHOR. Jean Tremblay, Département Systèmes, Version initiale.
Cela permet de savoir rapidement à qui s'adresser pour des questions sur le code, surtout dans un contexte de développement collaboratif ou de rotation des équipes.
Dernière mise à jour : Jeudi, le 28 juillet 2011