Coder proprement

2035041015-0

Je ne serais ni le premier, ni le dernier à vous parler de code propre, vous en conviendrez. Si je suis venu parler de ceci c’est parce que je suis en train de lire l’intéressant livre de Robert C Martin : « Coder proprement ». J’adhère sur certains propos que j’ai pu lire dans ce livre et j’avais envie de partager sur la toile mon avis à ce propos. *trop excité*

original

Qu’est-ce un code propre ?

Un code propre est :

  • un code lisible
  • un code simple
  • un code bien pensé/réfléchi
  • un code minimal si possible
  • un code améliorable par n’importe qui

Le fond c’est bien, mais la forme ça aide.

Un code indenté est toujours plus beau qu’un code non indenté ou mal indenté. J’en veux pour preuve la norme de l’école française réputée : l’Epitech. J’ai un copain qui y est et qui m’avait raconté que dès la première année, il vous impose une norme d’écriture. Si vous cherchez un peu sur Google, vous trouverez des bribes concernant cette norme. Elle apprend aux élèves à écrire du bon code (Il y a un autre raison à cette norme, mais là n’est pas le sujet).

Quand vous codez, faîtes comme si quelqu’un irait lire votre code après et que vous ne serez pas à ses côtés. En entreprise ce sera très certainement le cas. Le code sera maintenu par quelqu’un d’autre que vous.

Vous êtes une sorte d’écrivain, vous écrivez un roman, pour vous mais surtout pour les autres.

Un code propre c’est un bon code.

Je ne suis pas un programmeur expert, mais ma faible expérience me permet déjà d’adhérer à ces propos ! Combien de fois j’ai pu voir un code illisible bien qu’efficace ? Pour compléter la définition de code propre, je devrais rajouter qu’on devrait mettre un maximum de commentaires, pas forcément de faire un pavé digne de Guerre et Paix, mais une phrase explicite. L’anglais est effectivement le langage de rigueur. Je m’explique :

A titre d’expérience, j’ai travaillé sur un projet scolaire de logiciel de dessin vectoriel simplifié avec deux collègues. Le projet est visible sur un compte github. Durant le projet, j’ai pu jauger le niveau de mes deux collègues. L’un était très très fort, l’autre aussi bon que moi. Celui qui était très fort on va l’appeler Jacques, et celui qui l’était moins Michel. On a bossé en équipe et on s’est ramassé un 20/20.😀

auiomd

Bon, d’accord j’avoue j’ai choisi mes mots pour placer cette vanne😀

Jacques était très fort donc assez rapide à nous fournir du code. Son premier jet fut quasi illisible sauf pour lui. Mais pas seulement son premier jet en fait : peu à peu on avançait dans le projet, ses variables restaient parfois un mystère. Avec un peu de bon sens, j’arrivais à comprendre (mais pas tout) son code. Ce qui n’était, hélas, pas le cas de Michel !

49446854

Peut être bien que Jacques trouvait compréhensible d’écrire private Coord mse = new Coord(0,0); les coordonnées de la souris (mse > mouse), mais ce n’est pas forcément le cas pour nous autres !

Bon attention quand même à ne pas non plus à faire trop long comme nom de variable ! private Coord coordinatesOfTheMousePointerWeUseOnCanvas = new Coord(0,0); C’est un poil trop verbal. Préférez par exemple : private Coord coordMouse = new Coord(0,0);

Chacun à sa façon d’écrire, bien entendu. Mais il n’en reste pas moins qu’il vous incombe la responsabilité d’être compréhensible.

Toujours sur ce même projet, j’ai pris l’habitude de toujours commenter mon code. Je n’en suis pas peu fier !😀 Ce qui n’était pas le cas de mes collègues !

49447312

Franchement, c’est très probablement la deuxième raison pour laquelle Michel était perdu. (Du coup, comme on devait rendre un projet commenté, on a passé nos deux nuits blanches pour tout commenter…Merci les copains! Les joies du code).

En résumé, si vous revenez dans 3 mois sur votre code, et que cela vous semble pas très compréhensible du premier coup d’œil, peut-être que vous avez mal écrit vos variables, ou que les commentaires sont pas très utiles à la compréhension. D’un coup c’est moins parlant. D’où : un code propre, c’est un bon code.

Scout toujours, scout un jour !

Le-film-Quand-Gerard-Jugnot-joue-au-chef-scout-sur-W9-a-20h50_portrait_w674

Un truc qui m’a « marqué » dans ce livre c’est ce proverbe de scout : « Laissez le campement plus propre que vous ne l’avez trouvé en arrivant »
Rien à dire, tout y est dit:mrgreen:

Nan sérieusement, j’ai eu à un moment reprendre du code, quand j’ai vu le truc ça voilà ma réaction :

49447308

Le boulot est donc comme le dit la citation très illustrative, rendez ça propre. Et normalement, celui qui est passé avant vous devrait vous filer du code un peu près propre, et celui qui passera après vous aura un code encore plus propre. On partage notre code en communauté. C’est quasi communiste comme mode de pensée ahah…

Head in HandsNulle la blague.

 

Allez, conclusion hâtive (vachement même)

Je n’ai pas fini de lire le livre, certaines choses me dépassent encore, mais il est clair que c’est un ouvrage très intéressant à avoir dans sa bibliothèque !🙂

Je vous ai exposé les principales lignes, les plus importantes quoi, pour vous mettre l’eau à la bouche *splash*

BONUS (parce que je savais où le caser)

Code Simple de Beck (vu dans le livre) :

Par ordre de priorité, un code simple :

  • passe tous les tests ;
  • n’est pas redondant
  • exprime toutes les idées de conception présentes dans le système
  • minimise le nombre d’entités, comme les classes, les méthodes, les fonctions et assimilées

Une réflexion sur “Coder proprement

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s