[SQL] Nommer efficacement les fonctions, classes, etc.

[Metallic-84s]

Bonjour à tous,

J'aborde un sujet qui semblera dérisoire, mais que je trouve intéressant.

Comment nommer les différentes fonctions, classes, etc., et ce de manière efficace ? Par exemple, quelle nomenclature utilisez-vous pour vos fonctions, afin de travailler méthodiquement et rigoureusement, facilitant ainsi la mise à jour et la cohérences de vos différents programmes ?

(Pas forcément en PHP, mais dans la programmation en général.)

Merci à ceux qui me donneront leurs astuces et leurs conseils. ;-)

Bonne journée,
Metallic-84s

[Orian]

De mon coté je faos du Java.

Pour commencer je met mes classes se rapportant au "mêmes types d'actions" dans un même package nommé avec un mot clé commun à toute ses classes.
Je nomme mes package entièrement en minuscule (c'est la conventionn en java je crois).

Pour mes classes je les nommes en fonction des méthodes qu'elles contiennent.

Mes classes sont nommé avec les premières lettres de chaque mot en majuscule et mes méthode avec la première lettre en minuscule et les premières lettres des autres mots en majuscule (encore une fois c'est la conventionn en java je crois).


Par exemple :

package configuration ==> package avec toutes mes classes servant à la config
Classe ConfigIni ==> Classe servant à écrire dans un fichier .ini
méthode readConfig ==> pour lire
méthode writeConfig ==> pour écrire


Evidemment c'est ma mèthode

[Guardian_7]

Bonjour,

Pour ce qui concerne les classes, j'ai des conventions assez uniformes :

Une seule classe par fichier. Ceci te permet entre autres d'utiliser la méthode magique __autoload introduite en PHP 5.

Les conventions typograhiques :

Pour les classes :

MyExample.class.php

ou My_Example.class.php

ou encore myexample.class.php (moins lisible).

Pour les attributs :

Première lettre en minuscule ((nom de la classe*) + nom de l'attribut)

Exemples :

private myExampleId = NULL;

Pour les méthodes :

Verbe + (nom de la classe*) + attribut

Hésite pas à donner des (longs) noms explicites à tes méthodes.

*Ajouter une abréviation précise ou le nom de classe permet d'identifier plus rapidement l'attribut ou la méthode par rapport à son contexte.

Exemple... Si tu as plusieurs méthodes qui portent le même nom, mais qui sont déclarées dans plusieurs classes différentes sans aucun rapport, cela peut être difficile à comprendre lorsque elles sont instanciées les unes derrière les autres

Exemple de nom de méthodes :

getMyExampleById();

addMyExample();

editMyExample();

removeMyExample();

Par exemple, pour des méthodes spécifiques à une requête SQL :

insertMyExample();

updateMyExample();

deleteMyExample();

etc.

Pour le premier exemple : getMyExampleById() (littéralement "Obtient une instance de la classe Example par son attribut IDentifiant") : cette convention m'est inspirée du modèle DOM, je la trouve particulièrement explicite et uniformisable...

...Pour ce qui concerne les variables normales (hors contexte orienté objet) : elles sont en minuscules avec des sous tirets.

Exemple : l'attribut "myExampleId" deviendrait la simple variable $my_example_id.

De la même manière la méthode "getMyExempleById()" deviendrait "get_my_exemple_by_id()" si c'était une fonction classique.

Pour les constantes, toujours en majuscules avec sous-tiret(s) :

MY_CONSTANT_VALUE

Enfin, au niveau du nommage lui-même, moi ce que j'ai horreur de voir, c'est des pseudo-langages français-anglais (ou des abréviations du 3ème type).

du genre : "updateMonNom()" ou "modMonNom()" je préférerais encore "modifieMonNom()" ou au mieux "updateMyName()".

Pour ma part j'ai résolu l'ambiguïté : je code uniquement en anglais. (Ainsi mes scripts peuvent parcourir le monde si ça leur dit ).