Initiation à la programmation en Basic – ETAPE 4 : Documentation et présentation du code-source

Le code-source* est une succession de lignes de codes qui atteint vite quelques milliers de lignes (par exemple, le projet de développement qui m’occupe actuellement (un générateur de synthèses générales pour le CAC, cf http://www.auditsi.eu/?p=1533) dépasse déjà les six mille lignes) ; autant dire que la documentation et la présentation du code-source sont primordiales pour s’y retrouver… aussi primordiales que pour un dossier de CAC !

La lisibilité du code-source est améliorée par :

  • l’ajout de commentaires expliquant le fonctionnement du programme. Les commentaires sont incontournables ; c’est l’aide-mémoire du programmeur ; ces commentaires lui permettront de comprendre à quoi sert telle ligne de code… quand quelques mois plus tard, il aura à compléter son programme… Les commentaires sont précédés d’une apostrophe (touche « 4 » du clavier alphanumérique) ou par le mot clef REM (pour REMARK) ; ils ne sont ni compilés ni exécutés (ces termes sont expliqués dans une prochaine étape). L’utilisateur du programme n’a pas accès à ces informations. Les commentaires ne sont visibles que de l’auteur du code-source (ou de son équipe en cas de projets de grande envergure ; dans ce cas, les commentaires sont un moyen de communication interne…). Dans l’exemple qui suit, les commentaires fournissent des informations sur l’auteur du programme et annoncent les différentes parties du code-source (par exemple, la déclaration des variables).
  • l’indentation (c’est-à-dire le retrait le texte du code-source par rapport à la marge gauche) ; celle-ci permet de suivre visuellement la progression du programme dans les boucles et procédures (ces notions seront abordées ultérieurement). Cette mise en forme est purement conventionnelle ; le fait de ne pas la respecter n’a aucune incidence sur l’exécution du code mais réduit sensiblement sa compréhension par un autre programmeur.
  • la colorisation du code-source. Chaque composant du code-source (mot clef, variable, opérateur…) est coloré différemment facilitant sa lecture et la détection des erreurs de saisie. L’EDI colorise automatiquement le code-source, nul besoin donc de sortir ses feutres et autres crayons de couleur**…

Cet article est le dernier d’une série que les plus impatients trouveront plutôt théorique. Le prochain article nous permettra de rentrer dans le vif du sujet, de franchir un nouvel horizon, celui de l’homme qui dompte la machine (toujours avec une simplicité confondante) ! Vous commencerez à interagir avec la machine et surtout à la faire travailler… à votre place !

_____

* Le code-source correspond au texte du programme tel qu’il apparaît dans la zone d’édition de l’EDI.

** Petit clin d’oeil à certaines de mes collègues sans lesquelles nos dossiers seraient bien tristes…

Share Button
The following two tabs change content below.
Benoît RIVIERE
Après seize années passées en cabinet d’expertise-comptable et de commissariat aux comptes (où j’ai exercé comme expert-comptable et chef de mission audit), j’ai pris le poste de directeur comptable d’un groupe de distribution automobile en novembre 2014. Au cours de ma carrière, j’ai acquis une expérience significative en audit et en exploitation des systèmes d’information (analyse de données, automatisation des tâches, programmation informatique) au service de la production des comptes annuels et consolidés. C’est cette expérience personnelle et ma passion pour l’informatique que je partage sur ce blog. Mon CV / Réalisations personnelles et projets informatiques / Ma collection / Me contacter

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.