Le standard de programmation PSR2

Il y a plus de 18 ans, j’ai débuté à développer des sites web, pour plus tard apprendre le langage PHP avec base de données MySQL. Au départ, mes codes n’étaient pas très esthétiques et comportaient plusieurs erreurs de débutant. Avec le temps, après avoir approfondi mes connaissances, j’ai commencé à apprendre à bien programmer.

Aujourd’hui, j’aimerais discuter avec vous d’un standard de programmation très connu: PSR2 par l’organisme FIG. Il s’agit de règles à suivre pour garder son code propre et facilement réutilisable par d’autres programmeurs.

Lorsqu’on travaille en équipe, il est primordial d’avoir une uniformité au sein du code. Nous verrons quelques exemples.

Voici le lien vers la documentation officielle: https://www.php-fig.org/psr/psr-2/

Voici quelques exemples:

  • Les codes ne doivent être indentés qu’avec 4 espaces et aucune tabulation.

Pour comprendre cette règle, référons-nous aux multiples éditeurs ainsi qu’aux systèmes d’exploitation, car souvent des codes sont indentés différemment selon l’éditeur, ce qui donne un résultat très difficile à lire et loin d’être consistant. J’ai personnellement vu des différences d’indentation dans un même fichier.

  • L’ouverture d’accolade pour les classes doit se faire sur sa ligne propre.

En fait, ici, il s’agit d’être consistant dans tout le projet. La FIG aurait pu décider de permettre l’ouverture sur la même ligne que la déclaration de la classe. Le choix a été porté sur une ligne différente pour plus de clarté.

  • La fermeture ?> DOIT être omis si le fichier ne contient que du PHP.

Pour cette règle, c’est relativement simple. Vos fichiers classes et fichiers strictement PHP ne doivent pas fermer le tag. Pourquoi? Très souvent, des erreurs d’espace se glissent qui font perdre un temps énorme à la résolution de problème. En ne fermant pas ce tag, PHP ignore les espaces dans les fichiers.

  • Les mots-clefs et True/False/Null doivent être en minuscule.

Il s’agit surtout de permettre une uniformité, notons qu’inscrire les mots-clefs en majuscules est également fonctionnel, mais non standard.

  • La visibilité doit être inscrite sur toutes les méthodes.

Depuis les dernières versions PHP, nous pouvons spécifier la visibilité d’une méthode. Il est devenu standard de le faire pour tous. Ceci permet aux autres développeurs de savoir comment il peut l’utiliser en un coup d’oeil.

Il ne s’agit ici que de quelques exemples. Je vous conseille fortement de lire le document situé à https://www.php-fig.org/psr/psr-2/ si vous voulez écrire un code clair, portable et ainsi vous faire aimer de vos collègues programmeurs.

Laisser un commentaire

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