Petite technique pour améliorer la lisibilté de son code
Z0hung44r Il y a 2 ans Premium Pro2

Salut à toutes et à tous !

Aujourd’hui, un petit devlog dans lequel je souhaiterais partager avec vous une petite technique pour améliorer la lisibilité de son code.

Je l’ai trouvé en regardant le code source de quelqu’un lorsque j’étais en train d’apprendre à utiliser Vulkan (voici le lien de la série de tuto de cette personne : ici). Quand je l’ai vu, j’ai tout de suite adhéré et je l’ai immédiatement mise en pratique pour essayer. Aujourd’hui, je n’arrive plus à m’en passer (je suis même en train de réécrire tous mes codes sources avec ^^) !

Avant de passer aux cas concrets, je tiens à vous préciser que cette technique est universelle ! Vous pouvez l’utiliser pour tous les langages (sauf peut-être python) et sur tous les éditeurs !

Trêves de bavardages, voici le code d’un fichier C++ qui initialise des structures de Vulkan sans cette technique :

Et maintenant avec :

Même exemple, mais cette fois avec le fichier header de ce fichier C++, sans cette technique :

Et avec :

Le code est beaucoup plus clair, lisible et je trouve l’alignement très agréable à regarder.

Voici encore deux exemples d’applications en C# et en Lua qui pourront être plus parlant que du code C++ :

Déclaration de variables en C#, sans :

Et avec :

Déclaration de variable en Lua, sans :

Et avec :

On peut aussi l’utiliser pour les fonctions qui ont trop de paramètres !

(sans)

(avec)

Il est cependant clair qu’il faut utiliser cette technique sans excès sinon le résultat risque d’être contre-productif (par exemple lors de la déclaration de moins de 2-3 variables, il n’y a aucun intérêt à l’appliquer car cela pourrait rendre le code moins lisible en l’étalant sur la largeur). Après, c’est à vous de voir en fonction des cas et de vos goûts.

Il est aussi vrai que cette technique est beaucoup plus utile pour du code C++ et C# qu’elle ne l’est pour du code Lua. En effet, elle est très utile pour la déclaration des variables, fonctions et structures qui sont plus utilisé et requiert plus d’informations (accessibilité, type) en C# et en C++ qu’en Lua.

Avant de finir ce devlog, je tiens à préciser que personne ne m’a payé pour faire la promotion de cette technique.

Voilà, j’espère que ça pourra vous être utile.

Je vous remercie de m’avoir lu.

Bon code !

Comments (2)

cette technique de présentation est super cool et super vieille.. il me semble que qd j’étais gosse et qu’on écrivait ( et vendait ) du code sur papier, c’était déjà présenté comme çà 🙂

Comme tu le dis il faut l’appliquer mais attention à ne pas en abuser : en fait c’est comme tout , la bonne dose c’est le mieux

Laisser un commentaire

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.