La convention d’écriture PEAR est un ensemble de directives visant à assurer la cohérence, la lisibilité et la maintenabilité du code PHP.
Principaux éléments des PEAR Coding Standards :
- Structure du code :
- Indentation et longueurs des lignes : bien indenté son code et faire des lignes de 80 caractères pour améliorer la lisibilité.
- Structures de contrôle : Il faut placer les accolades sur la même ligne que la structure de contrôle avec un espace après le mot-clé.
2. Appel et définition de classe et fonctions :
- convention de notation camelCase ou PascalCase lors de la déclaration des variables et des fonctions : – Pour camelCase, il faut mettre une majuscule a chaque mot dans une variable sauf le premier (ex : $nomVariables) et pour PascalCase c’est la même chose avec une lettre majuscule dès le début (ex : $NomVariables).
- Définitions de fonctions : Les parenthèses doivent entourer les paramètres, sans espace à l’intérieur.
3. Commentaires :
- Il faut mettre beaucoup de commentaires dans le but de rendre la lisibilité du code plus facile pour les autres personnes qui pourront travailler sur l’algorithme.
- Chaque commentaire doit expliquer la fonction d’une ligne de code permettant de faire une action.
4.Inclusion de code :
- Utilisez <?php?> pour delimiter le code PHP, évitant ainsi la syntaxe abrégée <? ?>, conformément aux normes PEAR.
Source : pear.php.net