Ressources

Bonnes pratiques de la programmation

Les dix commandements...

  1. Commentez raisonnablement et lisiblement votre code. Documentez les entrées et les sorties de vos fonctions et de vos procédures.

  2. Indentez votre code de manière à mettre les blocs constituant le code en valeur. Utilisez une instruction par ligne et respecter une taille de ligne maximale. Séparez par des lignes les blocs d'instruction et les fonctions.

  3. Placez correctement les accolades : chaque accolade fermante doit être verticalement alignée à l'instruction définissant l'accolade ouvrante correspondante. N’omettez pas les accolades facultatives.

  4. Dès que quelque chose se répète (une même valeur, comme une taille en pixels, des blocs d’instructions similaires, par exemple le dessin de carrés de tailles différentes), factorisez votre code, soit avec une variable, soit avec une fonction ou procédure.

  5. Utiliser des conventions de nommage pour les variables, utiliser des noms commençant par une majuscule pour les classes et par une minuscule pour les variables et les fonctions, utilisez des noms en majuscules pour les constantes. Les noms doivent être de taille raisonnable tout en restant explicites.

  6. Initialisez les variables, n’utilisez pas de valeurs par défaut.

  7. N’utilisez pas de variable globale dans vos fonctions.

  8. N’essayez pas  d'écrire un code optimal, votre code doit clair et simple afin de faciliter sa compréhension, sa maintenance et son évolution par un tiers.  Quand votre code sera opérationnel, donc bien plus tard, il sera temps de penser éventuellement à son optimisation.

  9. Compilez/testez régulièrement votre code après chaque ajout/modification.

  10. Sauvegardez régulièrement votre code, pensez à numéroter et documenter vos différentes versions, ou mieux: utilisez un gestionnaire de versions.