Il est important dans un projet que les développeurs adoptent un style de développement identique. Ceci favorise la relecture du code et le débogage.
Ces règles n'est pas obligatoire, mais très fortement recommandée pour vos développements.
Le style d'indentation adopté sur PHPBoost permet de gagner en lisibilité et en clarté du code.
L'utilisation des tabulations et des espaces est très importante dans le code. Il faut aérer votre code pour le rendre plus lisible.
Nous allons voir plusieurs exemple ci-dessous.
Un espace avant la parenthèse. Les accolades ne sont pas sur la même ligne que la condition.
Il faut indenter le code.
Il s'agit donc d'indenter le code et non la partie déclarative.
Par convention, toutes les variables, y compris les variables de classes, doivent commencer par une minuscule.
Si la variable est une suite de mots, ils devront être séparés d'un tiret bas ou underscore (_).
Exemple :
Les classes ont également un traitement particulier en terme de convention.
Les classes doivent toujours commencer par une majuscule :
Si la classe est une suite de mot, chaque mot commence par une majuscule et ne sera séparé d'aucune manière :
Les fonctions doivent être en minuscule avec un underscore entre chaque mot.