Quand on crée un script PHP, on doit
inventer des noms. Les 2 éléments qui ont besoin qu'on doit nommer sont :
- Les variables
- Les fonctions
Ces noms doivent être clairs et compréhensibles.
Voici de mauvais exemples de noms de variables :
$temp, $data, $info, $pass, etc…
Si on prend $info, "info", mais sur quoi ? C'est ça qui est important de savoir ce que contient une variable.
Même si sur le moment cela peut présenter peu d'importance, quand on devra reprendre ce code plus tard, on risque d'avoir des difficultés.
Quelques règles :
- Ne pas avoir peur de mettre des noms un peu longs.
- On peut utiliser le symbole underscore "
_" pour remplacer les espaces. Rappel : les espaces sont interdits dans les noms de variables et fonctions.
Quelques bons exemples de noms de variables :
$ip_visiteur, $mot_de_passe, $pseudo_membre, etc…
Idem, pas besoin de longs discours car comme en XHTML, l'indentation du code permet de voir immédiatemnt les différents niveaux, et de s'y retrouver beaucoup plus facilement.
Les commentaires sont le compléments des noms clairs qui eux évitent de commenter chaque ligne.
Les commentaires sont plutôt faits pour expliquer le
sens général du code.
Rappel, il y a 2 types de commentaires :
- Ceux qui commencent par "//" qui permettent de commenter sur une seule ligne à la fois.
- Ceux qui commencent par "/*" et se terminent par "*/" qui servent pour des commentaires s'étalant sur plus d'une ligne.