Bien nomer ses fonctions

Répondre


Cette question est un moyen d’empêcher des soumissions automatisées de formulaires par des robots.
Smileys
:D :) :( :o :shock: :? 8-) :lol: :x :P :oops: :cry: :evil: :twisted: :roll: :wink: :!: :?: :idea: :arrow: :| :mrgreen: =D> #-o =P~ :^o :non: :priere: 8-|
Voir plus de smileys
  Revue du sujet
 

  Étendre la vue Revue du sujet : Bien nomer ses fonctions

Re: Bien nomer ses fonctions

par @rthur » 01 nov. 2009, 12:39

Je parle pour moi bien que la majorité des devs fassent ainsi:
> Je préconise l'anglais (hors commentaires)
> J'essaie que chaque nom soit explicite et dont l'initale soit en Maj. (sauf le premier mot)
> Jamais d'underscore dans les noms sauf dans mes fonction privées de class
> premiere lettre pour les retours correspont au typage (simulé ou non).
Personnellement je fais quasiment toujours l'inverse:
- noms de variable et fonction en français (plus clair et évite les soucis de noms réservés par PHP)
- toujours des underscores car je_trouve_cela_bien_plus_lisible_plutôt queDeToutCollerEnAlternantMajusculesEtMinuscules
- toujours des noms très explicites quitte à avoir des noms long mais c'est vraiment plus simple à relire par la suite sans se poser de question sur à quoi sert cette variable.

En résumé, le plus important c'est de trouver une convention de nommage qui te convienne (et/ou qui convienne à l'équipe dans laquelle tu travailles) et que tu t'y tienne.
Le plus pénible c'est surtout d'avoir à relire un code où les conventions de nommages changent suivant l'humeur du développeur.

Re: Bien nomer ses fonctions

par Victor BRITO » 01 nov. 2009, 12:07

Je préconise l'anglais (hors commentaires)
Si l'on souhaite coder en anglais, libre à soi ; mais, il faudra garder à l'esprit qu'on ne sera jamais à l'abri d'une mauvaise surprise si une future version de PHP décide de créer une fonction, une constante de fonction ou une constante magique dont le nom coïncide avec celui de la fonction, de la constante ou de la constante magique qu'on aura créées (et je ne parle pas des mots réservés). Autrement dit, le fait de nommer ses fonctions en français nous épargne ce désagrément.

Re: Bien nomer ses fonctions

par FuZZyLine » 01 nov. 2009, 10:56

Hello
Je me rends compte au fil de mes développement que j'ai toujours du mal à nommer mes fonctions correctement.
Dabord je me dit, pour faciliter la lecture, je nomme mes propres fonctions en Français, ça permet du premier coup d'oeil de différencier les fonctions du langage de celles créées.
Le problème c'est que souvent je me retrouve avec des nom batards moitié anglais / moitié français, car par exemple il est plus court d'écrire is_nom_valid() que prenom_est_valide(). Je remplace souvent quelques mots comme get au lieu d'obtenir, mais ce mélange de langue commence à me sortir par les yeux ^^
Du coups je me dit que je ferrais mieux d'éviter le français, et dans ce cas d'écrire is_name_valid(), mais je trouve ça un peu lourds de traduire tout. Car si je fait ça tant qu'a faire histoire d'harmoniser, il me reste plus qu'à faire pareil coté base de donnée et nommer tous mes champs en Anglais... pas très pratique dans même.
Auriez-vous des tuyaux ? des bonnes pratiques ?
[*]Petite dernière : Mieux vaut-til nommer une fonction par rapport à ce qu'elle fait ou à la valeur, ou type de valeur qu'elle retourne ?
Je parle pour moi bien que la majorité des devs fassent ainsi:
> Je préconise l'anglais (hors commentaires)
> J'essaie que chaque nom soit explicite et dont l'initale soit en Maj. (sauf le premier mot)
> Jamais d'underscore dans les noms sauf dans mes fonction privées de class
> premiere lettre pour les retours correspont au typage (simulé ou non).

'tit exemple rapide:

$iCount = (integer) Nombre
$bfWork = (Binaire/Flag) Action
.
.
.

A lire:
http://www.geekto.be/index.php/2008/05/ ... ement-php/

@+ bonne lecture ;)

PS: [*] Les 2 mon capitaine ;)

Bien nomer ses fonctions

par supercanard » 01 nov. 2009, 01:46

Hello

Je me rends compte au fil de mes développement que j'ai toujours du mal à nommer mes fonctions correctement.

Dabord je me dit, pour faciliter la lecture, je nomme mes propres fonctions en Français, ça permet du premier coup d'oeil de différencier les fonctions du langage de celles créées.
Le problème c'est que souvent je me retrouve avec des nom batards moitié anglais / moitié français, car par exemple il est plus court d'écrire is_nom_valid() que prenom_est_valide(). Je remplace souvent quelques mots comme get au lieu d'obtenir, mais ce mélange de langue commence à me sortir par les yeux ^^
Du coups je me dit que je ferrais mieux d'éviter le français, et dans ce cas d'écrire is_name_valid(), mais je trouve ça un peu lourds de traduire tout. Car si je fait ça tant qu'a faire histoire d'harmoniser, il me reste plus qu'à faire pareil coté base de donnée et nommer tous mes champs en Anglais... pas très pratique dans même.

Auriez-vous des tuyaux ? des bonnes pratiques ?


Petite dernière : Mieux vaut-til nommer une fonction par rapport à ce qu'elle fait ou à la valeur, ou type de valeur qu'elle retourne ?