Norme de programmation - Cégep de Saint

qwertyuiopasdfghjklzxcvbnmq
wertyuiopasdfghjklzxcvbnmqw
ertyuiopasdfghjklzxcvbnmqwer
tyuiopasdfghjklzxcvbnmqwerty
uiopasdfghjklzxcvbnmqwertyui
opasdfghjklzxcvbnmqwertyuio
pasdfghjklzxcvbnmqwertyuiop
asdfghjklzxcvbnmqwertyuiopa
sdfghjklzxcvbnmqwertyuiopas
dfghjklzxcvbnmqwertyuiopasdf
ghjklzxcvbnmqwertyuiopasdfg
hjklzxcvbnmqwertyuiopasdfghj
klzxcvbnmqwertyuiopasdfghjkl
zxcvbnmqwertyuiopasdfghjklz
xcvbnmqwertyuiopasdfghjklzx
cvbnmqwertyuiopasdfghjklzxc
Norme de
programmation
Guide de remise des
travaux
16/03/2010
Département d’informatique du cégep de
Saint-Hyacinthe

2
TABLE DES MATIÈRES
Normes de présentation................................................................................................................................. 3
En-tête ........................................................................................................................................................ 3
En-tête du programme ........................................................................................................................... 3
En-tête de méthodes .............................................................................................................................. 4
Règles de nommage ................................................................................................................................... 5
Nommage des méthodes ....................................................................................................................... 5
Nommage des variables ......................................................................................................................... 5
Nommage des variables membres ......................................................................................................... 6
Nommage des constantes ...................................................................................................................... 6
Déclaration ................................................................................................................................................. 6
Espacement ................................................................................................................................................ 7

3
NORMES DE PRÉSENTATION
EN-TÊTE
EN-TÊTE DU P ROGRAMME
Un encadré spécifiant le nom du ou des programmeurs, la date ainsi qu’une brève
description de l’utilité du programme (4 ou 5 lignes maximum) doit être placé au début
du programme. Cet encadré doit être fait comme ci-dessous.
FIGUR E 1: ENTÊTE D ’UN PROGRAMME

4
EN-TÊTE DE MÉTHODES
Chaque méthode doit être précédée d’un commentaire. Deux lignes blanches est alors
laissées avant le commentaire. Les commentaires doivent suivre le modèle suivant.
Aussi, chaque groupement logique d’instructions doit être précédé par un commentaire.
FIGUR E 2: EN-TÊTE D’UNE M ÉTHOD E
Pour sauver du temps Visual studio permet de générer automatiquement en modèle de
commentaire adapté lorsqu’on inscrit « /// » au-dessus de la signature de la méthode.

5
RÈGLES DE NOMMAGE
NOMMAGE DES MÉTHODES
Les noms des méthodes doivent contenir un seul verbe précis et au moins un nom.
Chaque mot de l’identificateur doit commencer par une majuscule, y compris le
premier. Les articles sont à proscrire. Le nom de la méthode doit être descriptif de son
rôle.
Exemples de noms à utiliser :
CalculerMoyenne()
AfficherEcranSaisie()
EffectuerMiseAJour()
Exemples de noms à éviter :
moyenne()
calculerlamoyennedeletudiant()
calMoyEtu()
Les méthodes, les accesseurs et les indexeurs sont ensuite déclarés. La codification est
similaire aux variables sauf que la première lettre est en majuscule. Le choix du nom
d’une méthode est basé sur l’une des 2 choses : l’action (avec un verbe à l’infinitif) ou le
résultat qu’elle produit.
Exemple : CalculerResultats() ou Compilation()
NOMMAGE DES VARIABLES
Les noms de variables doivent être en lettres minuscules, sauf s’ils contiennent plusieurs
mots. Dans ce cas, la première lettre de chaque mot de l’identificateur doit être une
majuscule sauf la première lettre du premier mot. Par exemple, on pourrait utiliser les
variables suivantes : tauxHoraire ou nbJoursAbsence.
Les variables sont déclarés en ordre alphabétique de type et ensuite en ordre
alphabétique de variable.
Par exemple, la liste de variable suivante :
boolean flag;
double taux;
int age;
int nbOrteil;