Style du code

Un article de Prog.

Métrique du code

• Longueur d'un fichier : 50 et 1000 lignes
• Longueur d'une fonction : 1 et à 250 lignes
• Largeur d'une ligne : 80 caractères
• Indentation : 4 espaces
• Nombre d'arguments d'une fonction ou méthode : 6
• Nombre d'attributs d'une classe : 10
• Nombre de méthodes d'une classe : 10

Un fichier ne doit pas être trop long (ex: moins de 1000 lignes). Attention à ne pas utiliser des fichiers trop courts non plus : multiplier les fichiers de moins de 20 lignes rend la navigation dans le projet plus difficile.

Ces nombres ne sont pas des règles à respecter à la lettre.

Nommer ses symboles

Casse des symboles :

• Classe : UneClasse
• Fonction et méthode : uneFonction
• Variable : une_variable
• Constante : UNE_CONSTANTE

Exemple tiré par les cheveux montrant qu'on peut utiliser le même symbole pour désigner différente chose en jouant sur la casse :

class ExemplePython:
    EXEMPLE_PYTHON = 42
    def exemplePython(self, un_argument):
        return un_argument * self.EXEMPLE_PYTHON
 exemple_python = ExemplePython()
 resultat = exemple_python.exemplePython()

Il faut bien choisir ses symboles. Un symbole trop court sera difficile à repérer visuellement. Idem pour des symboles trop proches. Des symboles trop longs seront pénibles à saisir (la complétion aide, mais elle n'est pas toujours disponible).

Exemple de noms :

• Plutôt que i, j, k utilisez index, item, element, etc.
• Plutôt que r utilisez value, text ou result