PageWikiniArchive
Aucune page n'a de lien vers ConvCodConventionDeNom.
Les classes doivent avoir un nom parlant.
Eviter les abréviations lorsque cela est possible.
Les noms de classes doivent toujours commencer par une majuscule.
Si le nom d'un classe doit être composé de plusieurs mots utilisez des "_" pour séparer les mots (voir ci-dessous). Chaque mot doit commencer par une majuscule.
L'architecture hiérarchique des classes doit aussi se retrouver dans le nom de la classe, chaque niveau de la hiérarchie est séparé par un trait souligné "_".
Exemples de noms de classe valides :
Log
Net_Finger
HTML_Upload_Error
Les fonctions et les méthodes doivent être nommées en utilisant le style "studly caps" (aussi connus sous les noms de "bumpy case" ou "camel caps" - NDT : ça vous aide ?;-).
Si possible, il vaut mieux débuter le nom d'une fonction ou d'une méthode par un verbe représentant l'action que doit réaliser la méthode ou la fonction.
Il est aussi préférable d'utiliser le français pour les nommer. Cela évite de rentrer en conflit avec les noms propres au langage de programmation.
Les fonctions doivent de plus avoir le nom du package comme préfix, pour éviter les doublons entre les packages.
La première lettre du nom (après le prefix pour une fonction) est une minuscule, et chaque premier caractère d'un nouveau "mot" doit être une majuscule.
Quelques exemples :
connecter()
prendreDonnee()
definirCouleur()
CHORO_DEP_possederCourriel()
Les éléments (méthodes, attributs) privés d'une classe sont précédés d'un simple souligné "_" (ces éléments sont destinés à n'être utilisés que par la classe qui les déclarent; PHP ne supportant pas encore le contrôle des noms privés). Par exemple :
_colorierCarte()
$this->_status
Les constantes doivent toujours être en majuscules, les mots séparés par des simples soulignés "_". Préfixez les noms des constantes avec le nom en majuscule de la classe/package dans laquelle elle est utilisée. Par exemple, les constantes utilisées par le package DB:: commencent tous par "DB_".
Si votre package a besoin de définir des variables globales, leurs noms doivent commencer par un simple souligné "_", suivit par le nom du package et un autre "_". Par exemple, le package PEAR utilise une variable globale appelée $_PEAR_destructor_object_list.
Concernant les variables classiques le programmeur peut au choix utiliser le style "camel caps" (ex: MaVariable) ou le style séparé par des soulignés (ex: ma_variable).
Mais il DOIT utiliser le même style tout au long de son code!
Toutefois, voici une façon de nommer les variables qui peut être utilisée par le programmeur (mais ce n'est pas obligatoire):
De façon générale, les variables doivent être de la forme (hormis les variables de compteurs) :
préfixe + type de la variable + nom de la variable
Préfixe :
Il n'est pas obligatoire. Il permet de définir l'originet et la portée de la variable. Nous pouvons utiliser les préfixes suivant :
glb Variable globale.
tmp Variable temporaire.
frm Variable provenant d'un formulaire html.
Type de la variable :
PHP n'est pas un langage typé mais il peut être intéressant de connaître le type de la variable sur laquelle on travaille.
Cela peut éviter de réaliser des opérations inapropriées sur les variables.
Types scalaires:
ent (ou int) Entier
dbl Float-point, double
cha (ou str) Chaine
bln Booléen
Types composés:
tab Tableau
aso Tableau associatif
obj Objet
Type special:
res Ressource
Nom de la variable :
Vous avez toute la liberté que vous voulez mais rester clair et constant dans votre façon de donner des noms.
Vous pouvez toutefois respecter les règles suivantes:
Aucune page n'a de lien vers ConvCodConventionDeNom.
Conventions de Nom
Classes
Les classes doivent avoir un nom parlant.
Eviter les abréviations lorsque cela est possible.
Les noms de classes doivent toujours commencer par une majuscule.
Si le nom d'un classe doit être composé de plusieurs mots utilisez des "_" pour séparer les mots (voir ci-dessous). Chaque mot doit commencer par une majuscule.
L'architecture hiérarchique des classes doit aussi se retrouver dans le nom de la classe, chaque niveau de la hiérarchie est séparé par un trait souligné "_".
Exemples de noms de classe valides :
Log
Net_Finger
HTML_Upload_Error
Fontions et Méthodes
Les fonctions et les méthodes doivent être nommées en utilisant le style "studly caps" (aussi connus sous les noms de "bumpy case" ou "camel caps" - NDT : ça vous aide ?;-).
Si possible, il vaut mieux débuter le nom d'une fonction ou d'une méthode par un verbe représentant l'action que doit réaliser la méthode ou la fonction.
Il est aussi préférable d'utiliser le français pour les nommer. Cela évite de rentrer en conflit avec les noms propres au langage de programmation.
Les fonctions doivent de plus avoir le nom du package comme préfix, pour éviter les doublons entre les packages.
La première lettre du nom (après le prefix pour une fonction) est une minuscule, et chaque premier caractère d'un nouveau "mot" doit être une majuscule.
Quelques exemples :
connecter()
prendreDonnee()
definirCouleur()
CHORO_DEP_possederCourriel()
Méthodes et attributs privés d'une classe
Les éléments (méthodes, attributs) privés d'une classe sont précédés d'un simple souligné "_" (ces éléments sont destinés à n'être utilisés que par la classe qui les déclarent; PHP ne supportant pas encore le contrôle des noms privés). Par exemple :
_colorierCarte()
$this->_status
Constantes
Les constantes doivent toujours être en majuscules, les mots séparés par des simples soulignés "_". Préfixez les noms des constantes avec le nom en majuscule de la classe/package dans laquelle elle est utilisée. Par exemple, les constantes utilisées par le package DB:: commencent tous par "DB_".
Variables Globales
Si votre package a besoin de définir des variables globales, leurs noms doivent commencer par un simple souligné "_", suivit par le nom du package et un autre "_". Par exemple, le package PEAR utilise une variable globale appelée $_PEAR_destructor_object_list.
Variables normales
Concernant les variables classiques le programmeur peut au choix utiliser le style "camel caps" (ex: MaVariable) ou le style séparé par des soulignés (ex: ma_variable).
Mais il DOIT utiliser le même style tout au long de son code!
Toutefois, voici une façon de nommer les variables qui peut être utilisée par le programmeur (mais ce n'est pas obligatoire):
De façon générale, les variables doivent être de la forme (hormis les variables de compteurs) :
préfixe + type de la variable + nom de la variable
Préfixe :
Il n'est pas obligatoire. Il permet de définir l'originet et la portée de la variable. Nous pouvons utiliser les préfixes suivant :
glb Variable globale.
tmp Variable temporaire.
frm Variable provenant d'un formulaire html.
Type de la variable :
PHP n'est pas un langage typé mais il peut être intéressant de connaître le type de la variable sur laquelle on travaille.
Cela peut éviter de réaliser des opérations inapropriées sur les variables.
Types scalaires:
ent (ou int) Entier
dbl Float-point, double
cha (ou str) Chaine
bln Booléen
Types composés:
tab Tableau
aso Tableau associatif
obj Objet
Type special:
res Ressource
Nom de la variable :
Vous avez toute la liberté que vous voulez mais rester clair et constant dans votre façon de donner des noms.
Vous pouvez toutefois respecter les règles suivantes:
- les lettres en minuscules
- les mots séparés par des soulignes "_"
- les variables servant de compteur doivent être de la forme $i, $j, $k et ainsi de suite...
- la variable contenant une requête sql devrait être de la forme $cha_requete
- la variable recevant le résultat de la requêtre devrait être de la forme $res_resultat