Coder
Proprement
La programmation, c'est l'art d'écrire du bon code.
Nous mettons un certain temps à écrire du code.
Mais nous passons également beaucoup plus de temps à lire du code.
La lecture d'autres codes est très enrichissante pour le développeur, mais peut être
fastidieuse si ces derniers sont mal écrits.
Un peu comme un mauvais roman que l'on ne finira jamais de lire, tant il est indigeste
pour les yeux.
Lors de la conception de projet en équipe, nous sommes amenés à travailler
sur le même code.
Il est donc important de se fixer des bonnes pratiques pour le bon déroulement
de la mission.
Pour résumer : un code "bien écrit" doit répondre à ces 4 attentes :
- Être facile à lire, par soi-même mais aussi par les autres.
- Être soigné et robuste dans le temps.
- Être explicite.
- Avoir une organisation logique et évidente.
Qu’est-ce qu’un code “bien écrit” ?
Il doit être facile à lire...
Pour qu'un code soit facile à lire, vous devez bien le structurer et l'indenter.
Vous devez également utiliser des noms de variables et méthodes parlants.
Respectez les conventions de nommage :
- Utilisez donc le camelCase pour la déclaration de vos variables, méthodes.
- Utilisez le PascalCase pour la création de vos classes.
Indentez et aérez votre code :
- Opérez un décalage (tabulation) lors de chaque nouvelle instruction.
Commentez votre code :
- Apportez des commentaires à vos méthodes ou fonctions.
- Commentez dans votre code uniquement les éléments clés du programme.
Ne surchargez pas votre code de commentaires. Cela devient fastidieux et contre productif.
Utilisez les fonctionnalités de vos IDE
Certains environnement de développement vous proposent des extensions ou intègrent directement cette fonctionnalité. Vous pouvez ainsi indentez plus facilement votre code.
Python
Le langage Python demande une rigueur particulière dans l'indentation du code.
Ce langage est donc à privilégier dans une phase d'apprentissage pour acquérir cette rigueur.
Il doit être explicite...
A la lecture de votre code, on doit comprendre rapidement de quoi il s'agit.
Il est donc important de nommer les variables avec des mots qui ont du sens.
Exemple : userMail
Il en va de même pour vos méthodes.
Nommez-les de façon explicite en commençant par un verbe à l'infinitif.
Exemple : deleteUser()
Enfin, ajoutez-y des commentaires appropriés en utilisant des phrases courtes.
Évitez les raccourcis !
Vous serez probablement amené à prendre des raccourcis de ce genre :
« Je crée une variable u pour user. »
Ces raccourcis sont à éviter car ils seront plus difficiles à comprendre par un autre lecteur ou par vous même, lorsque vous vous replongerez dans ce code, six mois plus tard.
Ne gardez que ces raccourcis pour les boucles for ou les exceptions.
Certains développeurs proscrivent le nommage d'une seule lettre y compris dans les boucles for...
Exemple : ( for i = 0 ) devient ( for nbrTour = 0 ) ou ( for index = 0 )
Il doit être soigné...
Pendant vos développements et dans le temps, vous serez amené à opérer des mises à jour de votre code.
Efforcez-vous à supprimer les éléments qui ne seraient plus utiles pour les remplacer par vos nouvelles fonctionnalités.
Opérez un Refactoring systématique si vous décelez des éléments identiques qui apparaissent dans votre code, afin de le rendre le plus générique possible.
Utilisez le plus possible des méthodes.
Ces dernières doivent avoir des actions limités.
Exemple : On ne crée pas une méthode qui trie un tableau et envoie un mail.
Mais deux méthodes distincte : une qui trie sortTabs() et une qui envoie un mail sendMail().
Puis on appelle éventuellement la méthode sendMail() au sein de la méthode sortTabs().
Enfin, optimisez votre code. Si ce dernier est simple, il sera plus efficient.
Évitez les fioritures et autres détours inutiles.
Refactoring (Réusinage de code) :
Le refactoring de code est l'opération consistant à retravailler le code source d'un programme informatique.
Cette opération ne cherche pas à ajouter de nouvelles fonctionnalités ou à corriger des bugs. Ellee consiste plutôt à améliorer la lisibilité, la maintenance ou à rendre le code plus générique.
Il doit avoir une organisation logique...
Efforcez-vous à respecter la même logique, tout au long de votre développement.
Ordonnez les choses de façon identique, dans chaque fichier de votre programme, pour en simplifier la lecture.
Exemple :
- Je déclare mes variables en haut du fichier.
- Je crée mes méthodes dans le bas du fichier.
- J’exécute la logique dans le centre du fichier.
Si vous décidez de suivre cette hiérarchie, vous l'appliquerez à l'ensemble de votre programme, de façon à uniformiser les fichiers entre eux.
L'analyse en sera donc plus simple pour le futur lecteur.
Synthèse...slam
Écrire du code, c'est plus qu'une simple tâche,
C'est un art, qui jamais ne se relâche.
Chaque ligne est claire, chaque mot est bien choisi,
C’est la clé d'un code qui vit et survit.
Indenter, le rendre lisible et précis,
C’est respecter le lecteur, c’est l’esprit.
Nomme tes variables avec sens et clarté,
Ton job sera compris et respecté.
N'aie pas peur d'utiliser le camelCase
Tu verras que tu seras plus à l'aise.
Penses au PascalCase pour créer tes classes
C'est ça un codeur qui a de la classe.
Teste chaque fonction et vérifie chaque chemin,
C’est dans les détails que se forge le lendemain.
Et n’oublie pas de documenter, d’expliquer,
Car bien coder, c’est aussi savoir partager.