ETSCODE > Notes de cours d'INF111 > Normes de programmation

Normes de programmation

Des règles de présentation et de syntaxe sont établies pour maximiser la lisibilité de nos programmes ;
Les normes du cours prennent une approche de programmation défensive. Le but est de minimiser le nombre d’erreurs possibles venant du programmeur.

L’espacement est les espaces vides horizontaux ou verticaux laissés dans nos programmes ;
L’espacement horizontal est nommé l’indentation. Chaque bloc de code aura un niveau d’indentation. Les blocs de code sont délimités avec un bloc de code (entre des { et } ;
Les espacements verticaux sont des sauts de lignes vides laissés pour délimiter les contextes entre les instructions ;
Les deux types d’espacements sont mutuellement exclusifs. Il ne doit pas avoir un changement d’indentation avec un saut de ligne. Le changement d’indentation aura priorité.

Les commentaires à l’intérieur du code existent pour expliquer le « pourquoi » de nos instructions. Leurs buts sont d’éclaircir pourquoi les instructions sont nécessaires pour arriver à la solution de notre programme ;
Évitez de « traduire » le code en commentaire. Cela donne un commentaire impertinent.

Au début de chaque fichier, nous aurons un en-tête qui explique le contenu général du fichier. En avançant dans la session, d’autres considérations seront ajoutées aux en-têtes ;
Les informations générales dans les fichiers seront une description du programme et d’autres informations pertinentes (auteurs, date).