Enseignement de Numérique et Science Informatique en terminale

Bonnes pratiques dans le développement de code informatique

Sommaire de cette page :

1. Écrire des commentaires dans le code

2. Nommer les variables et les fonctions

3. Indenter votre code

4. Copier/coller vos variables et portions de code identiques

5. Utiliser un logiciel créé pour le développement de code informatique

Développer un programme informatique sous forme d'algorithme sans erreurs et qui fonctionne c'est bien, mais développer un programme informatique sous forme d'algorithme sans erreurs, qui fonctionne et qui respecte les règles de codage reconnues par tous c'est mieux.

En effet, lorsqu'un programmeur développe un programme, il doit aussi penser que son programme pourra être relu par lui-même ou lu par d'autre quelque temps plus tard pour l'améliorer ou modifier une variable ou tout autre. De ce fait le programme doit être écrit « proprement » en respectant les quelques règles essentielles qui permettent de relire un programme facilement donc de se l'approprier plus rapidement.

Ce document a donc pour unique but de présenter les quelques règles de bon usage couramment utilisé par les développeurs de programmes informatiques.

Ces règles sont valables quel que soit le langage de programmation utilisé et quel que soit le niveau et la nationalité du développeur.

1. Écrire des commentaires dans le code

Écrire des commentaires c’est gagner du temps de compréhension du programme ; cela permet aussi de le faire évoluer plus facilement.

Il n'est pas nécessaire de commenter votre code ligne par ligne, c'est le sens général du code que vous devez expliquer dans les commentaires.

Syntaxe et symboles utilisés dans différents langages pour réaliser des commentaires :

2. Nommer les variables et les fonctions  

Donner des noms clairs et précis qui permettent de comprendre ce que représente ce nom : compteurDeClic ; nombreDeVies ; niveau ; phraseDeBienvenue ; decomposeNombreEnBase (nombre, base). Ne vous faites pas plaisir en écrivant des noms de variables ou de fonctions drôles dont vous serez les seuls à en comprendre le sens !

Exemples de mauvais noms de variables :

int to_to ;

float DuchmolANous2 ;

boolean 45ghJ5H2 ;

Exemples de noms de variables cohérents et explicites, avec du code commenté :

int brocheNumero2 ; // contiendra l’état de la broche 2

int compteurClic ;   // pour mémoriser le nombre total de clic

N.B. : un standard international se dégage actuellement sur l’écriture des noms de fichiers, de fonctions, de variables, etc. :

• l’initiale du premier mot est en minuscule (cherchez l’erreur dans l’exemple suivant);
• les initiales des mots suivant sont en majuscule ;
• aucun espace ou caractère _ ne séparent les mots concaténés (mis bout à bout).

3. Indenter votre code  

Indenter un programme, c'est décaler certaines parties du code afin de mieux comprendre sa structure, son fonctionnement. On peut utiliser une ou plusieurs tabulations ou simplement plusieurs espaces pour indenter du code.

Code (en c) indenté :

Remarque : dans le code ci-dessus, le nom des fonctions en orange respecte les conventions décrites précédemment, mais pas les nom de variables (c’est un code ancien).

4. Copier/coller vos variables et portions de code identiques 

Écrire une seul fois le nom de vos variables en tapant sur la clavier de l'ordinateur, lors de sa déclaration. Par la suite, il suffit de copier/coller le nom de chaque variable ou de fonction pour les utiliser. Cela permet d'éviter toutes erreurs de frappe et donc de problème par la suite ; de devoir chercher (parfois longtemps) l'erreur dans le programme.

5. Utiliser un logiciel créé pour le développement de code informatique  

Les éditeurs conçus pour aider le développeur utilisent :

• la coloration syntaxique qui colore les différents classes d’éléments pour mieux les repérer et dépister des erreurs de codage ;
• la reconnaissance des mots réservés dans chaque langage (le fichier doit être enregistré avec l’extension permettant l’identification du langage : *.py = python ; *.c = langage c ; *.html ou *.htm = langage du web ; …), ces mots sont colorés ;
• la suggestion de termes à choisir dans une liste de mots connus (réservés ou déjà définis) commençant par les lettres que l’on a déjà saisies au clavier. Cela évite des erreurs de frappe.

Remarque : les exemples de codes ci-dessus montrent en orange les mots réservés et les noms de fonctions (en c) ; en bleu les constantes, ...

Exemples de logiciels libres : Notepad++ ; Geany ; Code::Block (pour le langage c) ; ...