Norme de programmation - Cégep de Saint

qwertyuiopasdfghjklzxcvbnmq wertyuiopasdfghjklzxcvbnmqw ertyuiopasdfghjklzxcvbnmqwer Norme de tyuiopasdfghjklzxcvbnmqwerty programmation Guide de remise des uiopasdfghjklzxcvbnmqwertyui travaux opasdfghjklzxcvbnmqwertyuio pasdfghjklzxcvbnmqwertyuiop asdfghjklzxcvbnmqwertyuiopa sdfghjklzxcvbnmqwertyuiopas dfghjklzxcvbnmqwertyuiopasdf ghjklzxcvbnmqwertyuiopasdfg hjklzxcvbnmqwertyuiopasdfghj klzxcvbnmqwertyuiopasdfghjkl zxcvbnmqwertyuiopasdfghjklz xcvbnmqwertyuiopasdfghjklzx 16/03/2010

Département d’informatique du cégep de Saint-Hyacinthe

T ABLE 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

2

N ORMES DE PRÉSENTATION

E N - TÊTE E N - T ÊT E

D U P R O G R AM M E

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.

F IGURE 1: E NTÊTE D ’ UN PROGRAMME

3

E N - T ÊT E

D E M ÉT HO DE S

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.

F IGURE 2: E N - TÊTE D ’ UNE MÉTHODE

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.

4

R ÈGLES

DE NOMMAGE

N O M M A GE D ES M ÉT HO D ES 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()

N O M M A GE D ES V A R I A B L ES 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;

5

Lorsqu’on utilise un compteur, les variables I, j, k sont privilégié.

N O M M A GE D ES V A R I A B L ES M E MB R ES Pour nommer une variable membre, on utilise la même règle que pour le nommage d’une variable excepté qu’on ajoute le préfixe « _ » devant le nom de la variable. Par exemple, la variable membre qui représente le nom d’une personne serait « _nomVariable »

N O M M A GE D ES CO N ST A N T E S Le nom des constantes doivent être en lettres majuscules. On utilise le caractère de soulignement (_) pour en séparer les mots (p.ex. PI ou TAUX_HORAIRE). L’utilisation des constantes est obligatoire. Dès qu’on a une variable dont le contenu ne doit pas changer durant l’exécution du programme, on en fait une constante. Si on a besoin d’une constante physique ou mathématique, on en fait également une constante. On n’utilise jamais de valeur codé à la dure dans une méthode. Si l’on a besoin d’utiliser une valeur fixe, on utilise une constante.

D ÉCLARATION Les déclarations des constantes doivent constituer les premières lignes de code d’une méthode. La déclaration des variables suit la déclaration des constantes. Lorsqu’une variable est déclarée, il faut initialiser sa valeur à 0 pour les types numériques et à la chaîne vide ("") pour les chaînes de caractères. Pour les booléens, on a le choix. L’extrait de code ci-dessous montre ce qui est attendu pour les identificateurs (constantes et variables).

6

Lorsqu’on déclare les variables, les règles d’accès doivent toujours être identifiées. On déclare les variables private en premier, ensuite ce sont les variables protected et enfin les variable public.

E SPACEMENT  



Un blanc (espace) doit être inséré avant et après tous les opérateurs. Aucun blanc ne doit apparaître à l’intérieur des parenthèses () et des crochets []. Par exemple, il faut if (a > b), pas if ( a > b ). Il faut tab[3], pas tab[ 3 ]. Visual Studio ajuste les blancs pour se conformer à cette norme, mais assurez-vous qu’elle est respectée. Aérer le code avec des lignes blanches placées entre les blocs de logique, comme des paragraphes dans un texte. Éviter plus d’une ligne blanche d’affilée.

Les accolades ouvrantes { et fermantes } délimitent les blocs d’instructions et doivent se trouver une au-dessus de l’autre, comme dans le bloc suivant : if (a > b) { // un bloc d’instructions }

Retraits de ligne À chaque fois qu’un nouveau bloc d’instructions est débuté, et qu’il est subordonné à une ligne précédente (if, while, etc.), alors il faut le mettre en retrait par rapport à la ligne précédente. Par exemple, dans le if imbriqué suivant, il y a deux retraits, le second plus profond que le premier. if (a > b) { varTemporaire = a; a = b; b = varTemporaire; if (b > 3) { Console.Out.WriteLine("b supérieur à 3 !"); } }

Le retrait doit être de 3 caractères, soit la valeur par défaut que Visual Studio insère automatiquement.

7

Disposition du if et du while La structure if doit être disposée comme ceci, avec les accolades alignées verticalement. if (a > b) // il faut inverser les valeurs des variables { varTemporaire = a; a = b; b = varTemporaire; } else { Console.Out.WriteLine("Les valeurs sont triées."); }

Le while est similaire. while (valeur