INFO-H-100 : Conventions

Conventions de nommage

Nommer les variables et les constantes selon leur contenu et les fonctions selon leur tâche. Exemples : int age et bool isLeapYear(…).
Ne pas utiliser d'accents dans les noms.
Choisir une langue (français/anglais) et l'utiliser de bout en bout (sauf eventuellement pour les commentaires).
Choisir une convention de nommage tel que l'on puisse différencier les constantes et types définis par rapport aux fonctions, variables et paramètres. Ci-dessous, un exemple de convention de nommage.

Nommage des fonctions, variables et paramètres

Notation lowerCamelCase.
Le nom commence par une minuscule.
Chaque nouveau mot du nom est collé au précédent et commence par majuscule.
Exemple : isLeapYear(…)

Nommage des types définis (''typedef'')

Notation CamelCase.
Le nom commence par une majuscule.
Chaque nouveau mot du nom est collé au précédent et commence par majuscule.
Exemple : SquareMatrix

Nom des constantes

Toutes les lettres du nom sont en majuscule.
Les mots du nom sont séparés par un underscore (_).
Exemple : SIZE_MAX

Conventions de mise en forme du code

Les accolades doivent être au même niveau vertical que les instructions du bloc englobant.
Il faut respecter la même indentation de bout en bout pour les instructions des blocs englobés, par exemple quatre espaces.

Exemple :

int fonction()
{
   if(<condition>)
   {
      for(int i=0;i<N;i++)
      { 
         <instructions>
      }
   }
   else if(<condition>)
   {
      <instructions>
   } 
   else
   {
      <instructions>
   }
   return <int>;
}

Si un bloc est composé d'une seule instruction, vous pouvez écrire soit :

```
if(<condition>) <instruction>
```
```
if(<condition>) 
   <instruction>
```
```
if(<condition>) 
{
   <instruction>
}
```

Si le nombre de caractères d'une ligne dépasse la largeur d'une page, indenter proprement. Les retours à la ligne sont considérés comme des espaces par le compilateur. Par exemple :
- ```
if(<condition>
   and <condition> 
   and <condition> 
   and <condition> 
   and <condition> 
   and <condition>) 
```
En conclusion, vous devez avoir une convention de mise en forme et la respecter pour tout votre programme. Si dans certains cas limités, respecter ces règles d'indentation conduisent à une lecture plus difficile, vous pouvez utiliser un autre type d'indentation.
Votre programme doit pouvoir s'imprimer proprement et lisiblement sur des pages A4.