Parcours Accueil Tour guidé Initiation 1 h Initiation 24 h Révisions Exercices

📂 5-8 – Bonnes pratiques de nommage et de documentation des variables

Dans un programme  COBOL , la clarté du code repose en grande partie sur la qualité des noms que vous donnez à vos variables. Un bon nom permet de comprendre rapidement ce que contient la variable et comment elle est utilisée. En entreprise, des programmes peuvent contenir des milliers de variables : une bonne convention de nommage devient alors indispensable.

🎯 Objectifs d’un nom de variable clair

• 📖 Rendre le programme lisible pour une autre personne (ou vous-même plus tard)
• 🧠 Éviter les erreurs en comprenant l’usage prévu de chaque champ
• 🧩 Favoriser la maintenance, la relecture et le travail en équipe

📋 Règles générales de nommage en  COBOL 

• ✅ Utilisez des majuscules uniquement (c’est la convention historique du  COBOL )
• ✅ Séparez les mots par des tirets :  NOM-CLIENT ,  TOTAL-MENSUEL 
• ✅ Soyez précis :  DATE-PAIEMENT  est mieux que  DATE 
• ❌ N’utilisez pas de caractères spéciaux, d’espaces ou de chiffres en début de nom
• ❌ Évitez les noms trop courts comme  A ,  X1 ,  TOTO 

💡 Exemples concrets

 01 CODE-PRODUIT          PIC X(10).   *> Identifiant du produit
 01 MONTANT-TOTAL        PIC 9(5)V99. *> Total de la commande TTC
 01 NOMBRE-LIGNES        PIC 9(3).    *> Nombre de lignes lues dans le fichier
  

🖋️ Documentation intégrée par les commentaires

Ajoutez un commentaire à droite ou au-dessus de chaque variable importante :

 01 CODE-CLIENT          PIC X(6).    *> Code unique client (ex : "A12345")
 01 PRIX-UNITE          PIC 9(4)V99. *> Prix unitaire hors taxe
  

Pour les structures complexes, commentez chaque groupe :

 01 ADRESSE-LIVRAISON.             *> Adresse complète du client
    05 NUMERO-RUE      PIC 9(3).
    05 NOM-RUE        PIC X(30).
    05 CODE-POSTAL     PIC X(5).
    05 VILLE           PIC X(20).
  

✅ Astuces de lisibilité

• 🧠 Groupez les variables par thème : infos client, produit, calculs, états
• 📁 Utilisez des blocs visuels pour séparer les sections (lignes vides ou commentaires de groupe)
• 📌 Soyez cohérent dans le vocabulaire : ne mélangez pas  TOTAL ,  SOMME ,  MONTANT  sans logique claire

📌 Résumé

Un bon nom de variable  COBOL  est :

• 🧩 Précis (sans ambiguïté)
• 📖 Lisible et auto-descriptif
• 🛠️ Facile à maintenir et à comprendre