3 bonnes pratiques de programmation web à intégrer

Sites web et applications

Publié le 28 février 2019

3 bonnes pratiques de programmation web à intégrer

Retour au blogue Temps de lecture:
5 minutes

Lorsque l'on écrit du code dans un environnement web, on cherche souvent à être rapide et efficace, au lieu de s'assurer que son travail sera lisible pour un autre collègue. Or, le code doit être écrit avec l'intention d'être lu par un humain. En ce sens, il est important de s’entendre sur certaines conventions. Ici, nous allons parler des conventions à ne pas oublier : la mise en forme du code, le nommage et le code mort. On vous partage donc 3 bonnes pratiques de programmation web à appliquer pour un meilleur travail en équipe!

C'est un fait, le code va être plus souvent lu qu'écrit. D'où l'importance de définir rapidement des conventions pour son équipe. Les conventions de codage sont un ensemble de directives pour un langage de programmation spécifique, qui recommandent un style, des pratiques et des méthodes de programmation pour chaque aspect d'un programme écrit dans ce langage. Pourquoi ne pas établir une sorte de guide de rédaction du code ? Vous pourriez y ajouter ces bonnes pratiques de programmation web, compréhensibles pour tous.

1. S'entendre sur la mise en forme du code

L'une des bonnes pratiques de programmation web concerne la mise en forme du code. C'est-à-dire mettre les espaces et les retours de ligne aux bonnes places, savoir où mettre l’ouverture des crochets, etc. C’est dérangeant de se relire pour trouver ces petites erreurs, mais c’est pire pour la personne qui devra ajouter la prochaine fonctionnalité. Pour être plus efficace, choisissez avec votre équipe un standard de mise en forme, comme PSR-2 pour PHP, et laissez ce travail de correction uniforme à l’IDE.

2. Surveiller son nommage

Une autre bonne pratique de programmation web passe par le nommage. Il faut éviter les abrév (abréviations). Notre amour des abréviations est inversement proportionnel pour le prochain codeur. Et ça peut paraître contradictoire, mais prendre le temps d'écrire les noms au complet réduit le temps de lecture. À l’inverse, il ne faut pas trop en mettre non plus. Il n'est pas nécessaire de répéter le nom de la table dans le nom de sa colonne, ou encore d’ajouter son type à une variable, c’est compris dans le contexte. Le code est là pour faire un travail humain, il faut donc que le code soit écrit pour comprendre le besoin. Un nommage plus humain aide à se concentrer sur les besoins du client.

3. Éliminer le code mort

La dernière bonne pratique de programmation web à retenir concerne le code mort. Le code mort a plusieurs formes et plusieurs origines. La première forme (et ma favorite) est le code en commentaire. Souvent, ce sont des oublis. Malheureusement, ça ralentit encore une fois la lecture et donne l’impression que la personne n’a pas fait attention à la qualité de son code. Une autre forme de "code mort" est le code inutilisé. On le trouve suivant une condition impossible ou une méthode qui n’est jamais appelée. Est-ce qu’on a vraiment besoin de garder tout ce code mort? La réponse est non. Il faut accepter que le code mort ne servira probablement jamais et utiliser un système de gestion de versions pour garder une trace. Vous ne verrez jamais des clauses inutilisées dans un contrat, ou un paragraphe qui n’aucun lien avec l’histoire dans un roman, alors pourquoi garder du code mort?

Finalement, une fois que ces trois bonnes pratiques de programmation web sont comprises, il faut les répéter jusqu'à ce qu'on les oublie. Car comme l'a dit Anne Barratin, “La routine est la servante de l'habitude.“ Il faut jouer au scout et laisser le code plus propre que lorsqu’on l’a ouvert. Quand tout le monde parle soudainement la même langue, comme le sous-entend l'image ci-dessus, on réduit le temps de lecture et le nombre de «WTF» par minute. Parlez-en à votre CTO et entendez-vous sur des conventions. Voilà!

Pour terminer, on vous propose quelques lectures pour aider votre équipe à mieux performer. Bonne lecture!

https://www.php-fig.org/

https://phptherightway.com/

https://basecodefieldguide.com...

https://www.amazon.ca/Clean-Co...

https://www.amazon.ca/Clean-Co...



Introduction à HubSpot : Quel forfait Hubspot Marketing choisir?
Article précédent
Introduction à HubSpot : Quel forfait Hubspot Marketing choisir?
Boutique Amazon et Marketplace: 3 conseils pour vous lancer!
Article suivant
Boutique Amazon et Marketplace: 3 conseils pour vous lancer!
Vous souhaitez rester à l'affut?
Vous souhaitez rester à l'affut?
S'inscrire au blogue