INFO-H-100 : Conventions

Conventions de nommage

Nommer les variables et les constantes selon leur contenu et les fonctions selon leur tâche. Exemples : age et 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).
Ci-dessous, un exemple de convention de nommage. L'important est de choisir votre convention de nommage et d'indentation et de vous y tenir tout au long de vos programmes.

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(…)

Nom des variables utilisées comme constantes

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

Conventions de mise en forme du code

Il faut respecter la même indentation de bout en bout pour les instructions des blocs englobés, par exemple quatre espaces.

Exemple :

def fonction(n)
    if <condition>:
        for i in range(n):
            <instructions>
    elif <condition>:
        <instructions>
    else:
        <instructions>
    return <expression>

Si le nombre de caractères d'une ligne dépasse la largeur d'une page (80 caractères), indenter proprement. 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.