Structuration

Ce projet de synthèse d’images est conséquent, il peut facilement atteindre plusieurs centaines de lignes pour ceux qui iront jusqu’au bout des défis. On n’aborde pas un projet important comme on code une « centaine de lignes pour tester un truc ». On peut penser pouvoir le faire, mais, c’est un doux rêve.

Différents niveaux de structuration du code

  • 1 - Noms de variables significatifs

  • 2 - Une chose = une variable

  • 3 - Duplication de code => écriture d’une fonction

  • 4 - Noms de fonctions significatifs

  • 5 - Une action = une fonction

  • 6 - Logique de traitement claire

  • 7 - Gestion des dépendances

  • 8 - Commentaires / Documentation

  • 9 - Gestion des exceptions

  • 10 - Tests unitaires

  • 11 - Recette (VABF : vérification d’aptitude au bon fonctionnement)

  • 12 - Déploiement (VSR : vérification service régulier)

  • 13 - Maintenance (TMA : tierce maintenance applicative)

Voici les différents niveaux qui permettent de réaliser un « bon » logiciel. Pour la réalisation de ce projet, nous allons vous demander d’essayer d’atteindre le niveau 5, voir le niveau 6 pour les meilleurs.

Dans votre future vie professionnelle, vous travaillerez en équipe, c’est-à-dire que vous utiliserez le code rédigés par d’autres et que les autres vont utiliser votre code. Vous travaillerez sur des projets longs où il faudra souvent reprendre le code un an après pour ajouter des fonctionnalités ou corriger des bugs. Un code mal rédigé, mal structuré, où l’on ne sait pas ce qu’il se passe, fait perdre un temps conséquent à l’équipe. Il faut donc programmer avec méthode.

Les attitudes à éviter :

  • « Je structurerai quand j’aurais fini ». Il ne faut pas remettre l’organisation du code à plus tard car « plus tard » signifiera bien souvent jamais.

  • « je vais tout jeter et réécrire le programme ». Malheureusement, si la première version s’est faite sans structuration, la seconde risque de ne pas être plus brillante.

Pour aller plus loin : vous pouvez lire l’ouvrage « coder proprement » de Robert C. Martin qui constitue un recueil simple et efficace des principaux réflexes à adopter pour devenir un très bon développeur.