La poésie du code

Pour écrire du code, vous devez être capable de lire du code existant, de l’enrichir par votre instinct. Le code peut concerner n’importe quel sujet, un site éditorial, un site ecommerce, une interface web, etc. Le tout répond à un besoin. Cela peut paraître intimidant au départ, déstabilisant mais à force que votre expérience augmente, votre confiance s’installera. Toutefois, il vous faudra toujours vous inspirer des multiples projets au sein de votre équipe mais également présents sur github, ou des sites spécialisés. A votre tour, il sera envisageable de partager votre code, votre savoir-faire.

Préparer la composition de votre code

Faites des exercices d’écriture

Il n’y a pas de secret : c’est en s'exerçant qu’on devient forgeron. Une idée simple peut vous amener à créer des fonctions, des solutions que vous étofferez au fil de l’eau.

Par exemple, vous pouvez avoir un besoin quotidien qui revient régulièrement. Vous pouvez établir une solution pour que ce besoin ne soit plus une corvée en gagnant du temps et ainsi vous permettre de passer à autres choses plus attrayantes.

Essayez de mettre sur le papier vos idées, d’enrichir de façon heuristique cette idée. Exemple : créer un agenda, oui mais accessible à tous ? Éditable par tous ? En quoi votre solution sera plus fraîche que les autres ?

Inspirez-vous de votre environnement et des personnes qui vous entourent

Vous travaillez au sein d’une équipe, vous vous intéressez à des groupes de travail. Tous ces éléments sont des sources potentielles de votre inspiration. Elles vous apporteront un autre angle de vision que la vôtre.

Essayez de refaire le code d’un collègue à partir du cahier des charges. Puis comparez votre code au sien pour voir vos méthodes, vos visions, vos divergences.

A tout cela s’ajoute l’environnement de développement. En effet, si vous devez développer une nouvelle fonctionnalité au sein d’un framework et/ou d’un CMS, vous vous devez de regarder comment sont écrites les différentes fonctions et API du framework. Inspirez-vous des plugins existants. Cela vous permettra d’écrire du code en harmonie avec l’environnement de développement.

Choisissez un thème ou une idée en particulier

Mettez sur le papier (ou dans un fichier depuis votre IDE) vos idées de fonctions et/ou de structures telles que cela vous vient. Cela donnera votre trame, un objectif.

Pour reprendre l’idée de l’agenda, vous pouvez déterminer les autorisations génériques, mais aussi le CRUD, les API d'interfaces.

Choisissez une forme de code

Ici, vous devrez décider la façon de coder : KISS, YAGNI, DRY, API, OOP, REST ?

Le style que vous allez prendre va vous permettre de rester constant au fil du temps, au fil du projet. Que vous maitrisiez ou pas cette forme, restez constant tout au long de votre code dans la mesure du possible.

Lisez des exemples de codes

Vous n’êtes pas le premier à avoir rencontré cette problématique. Alors regardez ce qui a été fait par vos pairs. Github est un ami pour vous! Gitlab également. Le monde est vaste, ne vous y perdez pas! Vous n’êtes pas seul à travailler sur du code, prenez l’habitude de faire une revue de code sur les autres projets pour vous enrichir.

Ecrire le code

Utilisez des fonctions concrètes

Evitez des formes abstraites de noms de fonctions. Votre code doit être lisible par quelqu’un d’autres mais également par vous même 2, ou 3 semaines plus tard voir plusieurs mois plus tard. Pour éviter des télescopage entre vos noms de fonctions (surtout si vous intégrerez vos développements dans un plus gros projet, un plugin, un module, etc.), il est conseillé de préfixer vos fonctions pour en faire une famille.

Dans chaque langage de programmation, il existe des fonctions standards. Utilisez-les de préférence avant de refaire la roue. Après cela, vous pourrez créer vos propres fonctionnalités pour arriver à vos besoins.

Utilisez des commentaires utiles

Les commentaires sont primordiaux dans un code. Ils permettent de s’y retrouver plus aisément et également de savoir où nous allons. Selon le langage de codage que vous choisirez, il existe des méthodes de commentaires : PHPDoc, JSDoc, Javadoc, etc.

N’ayez pas peur de marquer tout ce qui fera votre fonction.

Concentrez-vous sur la lisibilité

Même si ce “n’est que du code”, il doit rester lisible à l’oeil. Alors faites attention à votre indentation. Choisissez une norme de codage : PSR, Sun Coding Convention, GNU Coding Convention, etc.

Cette convention permettra que plusieurs développeurs puissent se comprendre.

Évitez les pièges

Il faut absolument éviter les pièges et pour cela, il n’y a qu’une solution : tester votre code!

Soit votre IDE vous aidera à détecter les problèmes, soit l’exécution de votre code pointera des résultats non attendus. N’oubliez pas d’activer le mode développeur de votre interpréteur. Par exemple, en php, on va activer l’affichage des erreurs. C’est aussi un gage de performance de votre code.

Peaufiner votre code

Relisez votre code à voix haute

Une fois que votre code a été écrit, relisez-le. Cela vous permettra de détecter des incohérences. Faites attention aux enchaînements des fonctions, des appels, des inclusions. Dans la précipitation, vous verrez que vous aurez fait une faute de frappe (inversion de 2 caractères, etc.).

Faites relire votre code

Vous pouvez faire relire votre code par des collègues afin de recevoir des critiques constructives pour améliorer votre code. Cela permettra de vous apporter un point de vue différent, de voir une problématique sous un autre angle.

Révisez votre code

Fort des avis de collègues ou de vos tests, vous allez pouvoir revoir votre code pour le modifier jusqu’à ne plus pouvoir l’améliorer. Basez vous sur ces différents pour supprimer des lignes de code inutiles. Assurez-vous que chaque fonction contribue à l’objectif prévu, à la convention de codage, à la forme.

P.S.

Cet article est fortement inspiré de l’article “Comment écrire un poème” de WikiHow. C’est un hommage à la poésie et ainsi vous dire que le code n’a rien d’abscon, d’indigeste. Il y a des poésies qui vous touchent, d’autres qui vous laissent indifférents. Il en va de même pour le code. Vous devez vous exprimer avec vos lignes de codes sans avoir à vous battre, et rester en symbiose avec le code et que votre code soit harmonique.

Un commentaire

  1. J’avoue que j’aimerais, bien comme vous, y voir de la poésie…10 ans que j’essaie de me mettre au code et 10 ans que j’échoue…La prochaine fois sera la bonne. (il faut que je me dépêche, je ne suis plus si jeune…) 🙂

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Captcha *

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