Produire un code “propre”
Publié le 25 September 2007, par Babozor dans la catégorie Développement, Gestion de projet, OutilsC’est la journée monsieur propre (après comment quitter proprement un boulot) aujourd’hui…
Comment produire un code qu’on pourrait qualifier de “propre”.
Cette notion est assez fluctuante d’une personne à une autre, l’objectif étant de produire un code qui soit portable, reprenable facilement, en deux mots compréhensible.
1. unité de langue
Choisissez une langue (de préférence l’anglais) et écrivez dans cette langue, aussi bien les commentaires, les noms de fonctions, classes, variables, etc…
2. une norme pour le nommage des classes / fonctions / variables
Utilisez ou créez une norme pour le nommage de toutes vos classes, fonctions, variables… un système cohérent.
Cela dépend de votre façon de coder, mais faites en sorte que l’éventuel lecteur (ou correcteur) ne soit pas perdu.
Par exemple, les noms de variables en anglais et séparés par des underscore ou par des majuscules: myFunction ou my_function.
Cela facilite beaucoup la lecture d’avoir un système de nommage cohérent.
3. rassembler les lignes réutilisables en classes / fonctions
Pour toutes les fonction massivement utilisées dans votre code (comme par exemple les fonctions de connexion aux base, requêtage, envoi de mail, log, etc… ou toute fonction beaucoup utilisée), n’hésitez pas à mutualiser votre développement. Créez une classe, des fonctions et mettez là dans un fichier à inclure…
Cela rendra votre code beaucoup plus lisible, en enlevant tout le code parasite (et ça évite les séances de copier/coller qui sont d’une autre ère!!)
4. commenter au besoin
Commentez avec parcimonie… seulement les portions de code qui pourraient poser problème pour une bonne compréhension de votre code.
Ne soyez pas trop verbeux, indiquez juste le but de telle ou telle ligne pour aider la personne qui passera après vous.
5. indentez
N’hésitez pas à indenter votr code, cela à tendance à aérer et à améliorer sa lisibilité.
La aussi chacun à sa manière de la faire (plus ou moins), mais faites le ça vous évitera des blocs monstrueux de code, ultra lourd à digérer.
La difficulté de tout ceci est de bien doser le taux de “propreté”… l’objectif étant d’avoir le code le plus propre possible en un minimum de temps. Si vous avez une page toute simple, avec une fonction elle aussi toute simple, pas besoin d’en faire des tonnes… mais c’est rarement le cas. On doit souvent faire face à des applications compliquées, utilisant des fonctions avancées, etc.
Un maître mot: pensez comme si vous deviez reprendre le code que vous écrivez. Mettez vous à la place de la personne qui risque de reprendre votre code et commentez ce qui vous parait obscure (ou vous a demandé beaucoup de cogitation), ordonnez votre code pour que la structure soit claire et qu’on puisse naviguer dedans aisément.
Reprendre le code de quelqu’un d’autre est souvent une épreuve difficile, surtout quand on tombe sur un code des plus crade. Je l’ai expérimenté maintes et maintes fois… c’est une horreur.
D’un autre côté, on a pas souvent l’occasion de prendre suffisamment de temps pour rendre un code nickel, bien organisé, bien indenté.
Le tout reste de trouver le bon équilibre entre propreté/lisibilité et temps passé.
le 26 September 2007 à 08h01
Pas mal le billet… J’en avais publié un similaire il y’a mais je n’ai pas du tout pensé à parler de commenter le code, pourtant indispensable dans le cas où le code serait repris par quelqu’un d’autre que son créateur !
le 27 September 2007 à 14h46
Effectivement pas mal, mais où trouver plus de détail sur les normes de codages, notamment en c#?
Merci