Suivre quelques conventions, même simples, vous aidera à éclaircir votre code en le rendant plus lisible et donc plus facilement maintenable. De plus, si un développeur doit mettre le nez dedans, sa lecture et sa prise en main sera grandement facilitée si vous lui transmettez un document récapitulant vos conventions.
Les points que je présente ici ne sont pas des lois mais simplement les conventions de codage PHP que je m’efforce de suivre; libre à vous d’y piocher vos propres “habitudes”, l’important étant de suivre la voie qu’on s’est fixé.
Error_reporting doit être à E_ALL et le code ne doit générer aucune notice ou warning.
Register globals à OFF, on se sert donc de $_POST et $_GET (notamment) pour accéder aux variables globales.
Short open tags à OFF, on sert donc de <?php et ?> pour délimiter les scripts (et pas <? ?>)
Les noms de fonction doivent commencer par un verbe. Exemple: getUserLogin()
Les noms de variables sont en minuscule. Les constantes sont toujours écrites en majuscules.
Le “Camel Case” est la pratique qui vise à utiliser une majuscule comme séparateur de mots. Exemple : userLogin.
La Notation Hongroise est une convention qui vise à “pseudo-typer” les variables, en indiquant leur type dans leur nom. Par exemple, le “tableau de résultats” sera nommé aResults (pour array), le “nombre de pages” sera “nPages”…
Que ce soit pour les fonctions, les boucles, ou les instructions conditionnelles, on place, au choix, les accolades en fin de ligne ou au début de la suivante. Par contre, on les met même quand elles sont facultatives. Pas de
mais plutot :
Quand on boucle sur le contenu d’un tableau, ne pas écrire :
mais :
Cela évite des calculs inutiles (le comptage des éléments du tableau n’est réalisé qu’une fois)
On suivra la norme JavaDoc (sans en faire trop, non plus):
Toutes les fonctions et classes devraient être commentées.
(Note: il existe des outils pour générer de la documentation HTML à partir des commentaires du code source, comme phpDocumentator, objet d’un prochain post)