Voir la source de Les 7 caractéristiques d’un code simple (KISS)

[[Category: Portail Equipe de développement]]
[[Category: Alberto Gutierrez]]
Auteur :  Alberto Gutierrez<br/>
Source : [http://www.makinggoodsoftware.com/2009/10/30/the-7-characteristics-of-simple-code-kiss The 7 characteristics of simple code (KISS)]<br/>
Date : 30/10/2009<br/>
----
Traducteur : Fabrice Aimetti<br/>
Date : 06/11/2009<br/>
----
Traduction :<br/>
<br/>
J’avais l’habitude de croire que la qualité la plus importante d’un code était son extensibilité (~ajouter de nouvelles fonctionnalités). Le code a dû être préparé aux futurs changements donc j’ai codé beaucoup de choses qui ne sont pas tout de suite nécessaires. Mais après avoir réalisé que je n’avais jamais bien deviné les changements à venir, et après avoir eu pas mal de cauchemars lors des maintenances et des passages de connaissance, il y a quelques années j’ai finalement décidé que je prendrai la démarche inverse de ce qui est sensé être un bon code. Depuis que je l’ai fait, je suis chaque jour plus convaincu que la principale caractéristique d’un bon code est sa simplicité. Un code simple est facile à lire et facile à changer. Et parce qu’il est simple, il est le moins susceptible d’avoir des bogues (plus l’algorithme que vous créez est complexe, plus les changements peuvent générer des erreurs).<br/>
<br/>
Lorsque vous codez, je vous recommande de vérifier chaque fois si votre code est resté simple, et n’oubliez pas : "il n’y a pas de problèmes difficiles, seulement les solutions".<br/>
<br/>
'''Les sept caractéristiques principales d’un code simple sont :'''<br/>
<br/>
'''1. Facile à lire'''<br/>
<br/>
Un code simple n’a pas besoin de documentation supplémentaire, ou alors d’un minimum de documentation pour être compris.<br/>
'''2. Facile à utiliser'''<br/>
<br/>
Celui qui utilise votre code considère intuitif d’utiliser vos objets.<br/>
<br/>
'''3. Facile à changer'''<br/>
<br/>
Simplicité veut dire qu’il n’y a pas de logique redondante. Un changement doit correspondre à un seul endroit dans votre code.<br/>
<br/>
'''4. N’utilise aucun outil ou technologie qui ne soit nécessaire'''<br/>
<br/>
D’après mon expérience, j’ai constaté combien certains développeurs adoraient utiliser les technologies, outils et frameworks pour le simple plaisir de rendre le projet plus "cool". Chaque fois que vous les utilisez, vous ajoutez de la complexité, et de la complexité supplémentaire signifie que c’est plus difficile à comprendre, à maintenir et que c’est davantage vulnérable aux défaillances.<br/>
<br/>
'''5. Ça a l’air simple'''<br/>
<br/>
Si cela n’a pas l’air simple, alors ce n’est pas simple ! Vous savez que votre code est simple si, quand vous avez fini, vous êtes étonné de constater la simplicité de la solution finale et vous vous demandez pourquoi cela vous a pris si longtemps.<br/>
<br/>
'''6. Lean'''<br/>
<br/>
Il ne fait que ce qui est nécessaire, et rien d’autre. Je pense que les développeurs les plus expérimentés seraient d’accord pour dire que tenter d’anticiper les problèmes auxquels votre code devra faire face dans l’avenir est impossible.<br/>
<br/>
'''7. C’est direct'''<br/>
<br/>
Il n’a pas d’indirections inutiles. Les opérations les plus importantes nécessitent seulement un appel direct à une méthode.<br/>
<br/>
'''Comment pouvons-nous développer un code simple ?'''<br/>
<br/>
La clé de la production d’un code simple est de le remanier (~refactoring) continuellement, et la seule façon de le faire est de le tester continuellement.<br/>
<br/>
Vous allez avoir besoin de le remanier parce qu’à chaque fois que vous allez ajouter une nouvelle ligne dans votre algorithme, vous allez probablement le rendre plus complexe. A partir de maintenant, à chaque fois, vous devez le remanier pour le ramener à un juste niveau de simplicité.<br/>
<br/>
Vous avez besoin de nombreux tests parce que vous le remaniez constamment et que, si vous n’avez pas un filet de sécurité, vous introduisez des bogues dans votre système.