Discussion :

[PseudoCoder]

Salut,

Désolé pour le titre à la noix... pas pu résister (ça doit être l'heure et la fatigue).

Tout le monde s'en tape, mais je suis en train de développer une modeste petite classe que je compte redistribuer (encore désolé, j'aime bien raconter ma vie).

La question qui me turlupine (j'aime bien ce mot, allez savoir pourquoi) concerne la syntaxe et la mise en forme de mon code.
Comme il n'y a pas de réel standard, tout est à peu près permis, tant que ça reste dans le domaine du raisonable : je n'ai pas l'habitude de donner des noms farfelus à mes fonctions ni à mes variables, et je commence même à m'habituer aux noms à rallonge s'ils sont explicites.
J'ai vu que certains préfixent certaines fonctions (ou de variables) avec un underscore ( _ ). A quoi cela correspond-il ? Je prends un exemple récent, donné par kankrelune dans un thread que j'avais initié :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
function pluginIsLoaded($plugName)
      {
            ...
      }
 
      function _loadPlugin($plugName)
      {
            ...
      }
 
      function execPlugin($plugName)
      {
            ...
      }

D'une manière plus générale, est-ce que vous avez des manies sur le nommage des fonctions/variables ?
Dans quels cas utilisez-vous des _ ? Exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

function write_file()

Dans quels cas utilisez-vous des majuscules ? Exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

function writeFile()

Mélangez-vous les deux ? Exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

function write_BidonFile()

Je ne doute pas un instant que ce sujet soit un sujet à la noix (comme le laissait présager le titre) mais j'y accorde cependant beaucoup d'importance.

Je précise qu'il ne s'agit pas ici des commentaires du code : pour ma part, je n'ai pas encore choisi quel générateur de doc je vais utiliser (ni même si je vais en utiliser un). Mais cette question fera aussi l'objet d'une étude approfondie.

Ah tiens, j'en profite pour faire un coucou à ma maman, mon petit frère, ...
Euh non plus sérieusement... Avant d'atterrir ici, je bidouillais en php (reprise de code, adaptation d'applis, etc). Mais là, depuis 2 jours j'ai envie de développer correctement. Je m'attarde donc beaucoup sur des questions qui peuvent paraitre des détails pour certains, mais qui me paraissent au contraire essentielles (maintenance/évolution du code, reprise d'un projet, travail en équipe, relecture (sic), base comme exemple, etc).
Merci donc aux personnes qui prennent le temps de répondre, de réfléchir, d'écrire, même quand on a taggué un sujet comme Résolu pour y apporter d'autres détails, toujours pertinents.

Voilà, j'ai fini mon pavé.

[elitemedia]

Tu me semble bien en forme...

Pour ce qui me concerne, j'utilise plutôt la version:

function write_BidonFile()

En fait, je mets un underscore dans le cas ou la fonction crée une action, exactement comme dans ton cas, "write" est ce que je considère comme une action. Dans certains cas, j'utilise la version en majuscule sur les mots importants.

En fait c'est surtout comme tu le ressens toi, il n'y a pas vraiment de règle. La seule règle qui m'importe vraiment, c'est de mettre des noms de fonctions suffisament parlant pour comprendre ce que fais la fonction. En revanche je suis très strict sur la facon de présenter mon code et j'utilise pour ceci la facon "PEAR" pour le faire.

A part ca, si ta famille nous lit, bonjour en passant

[PseudoCoder]

Salut,

Merci pour ta réponse. Le problème est que je ne sais pas exactement comment je le ressens En fait, ça dépend un peu des jours... Du coup, ça peut donner des variantes dans les règles de nommages de mes fonctions/variables.

Dans mon cas présent actuel du moment (non, je n'aime pas les pléonasmes), j'ai plusieurs fonctions d'écriture, de lecture, etc. Je pense que je vais les regrouper par type d'action : write, read, add, remove, etc. L'action servirait de préfixe.

Ca ne m'explique cependant pas pourquoi certains utilisent des noms de fonctions ou de variables qui commencent par un _ ... ? (ca, c'est juste de l'information)

[Petibidon]

hello,

perso j'utilise la méthode best practices java... certes ca a pas grand chose à voir avec php mais bon...

soit :

majuscule aux noms de classes : class Machin{...

minuscules pour les fonctions : function bidule( ... ){...
sauf lorsqu'elle est composée de plusieurs mots, majuscules aux mots sauf le premier, jamais de _ : function biduleTruc( ... ){ ...

en ce qui concerne les fonctions commencant par _, difficile de se mettre à la place de celui qui l'a faite, mais à la limite ca peut etre pour marquer une fonction "private" en php4... juste un pense bete quoi...

pour continuer dans les conventions de codage :

un "s" à la fin des tableaux... c'est tout con mais ca clarifie un peu les choses.

les constantes en majuscules etc.

et enfin, toujours un marqueur (et un seul) en fin de ligne.. soit le ";" normal, soit le marqueur de début de bloc "{" :

pas de

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
 
function truc()
{
    echo "bidule";
}

ni de

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
 
function truc(){ echo "bidule"; }

mais

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
 
function truc(){
    echo "bidule";
}

tchuss' !

[sahid]

hello,

perso j'utilise la méthode best practices java... certes ca a pas grand chose à voir avec php mais bon...

soit :

majuscule aux noms de classes : class Machin{...

minuscules pour les fonctions : function bidule( ... ){...
sauf lorsqu'elle est composée de plusieurs mots, majuscules aux mots sauf le premier, jamais de _ : function biduleTruc( ... ){ ...

en ce qui concerne les fonctions commencant par _, difficile de se mettre à la place de celui qui l'a faite, mais à la limite ca peut etre pour marquer une fonction "private" en php4... juste un pense bete quoi...

pour continuer dans les conventions de codage :

un "s" à la fin des tableaux... c'est tout con mais ça clarifie un peu les choses.

les constantes en majuscules etc.

et enfin, toujours un marqueur (et un seul) en fin de ligne.. soit le ";" normal, soit le marqueur de début de bloc "{" :

pas de

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
 
function truc()
{
    echo "bidule";
}

ni de

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
 
function truc(){ echo "bidule"; }

mais

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
 
function truc(){
    echo "bidule";
}

tchuss' !

Salut, j'utilise les mémé convention que toi Petibidon

et pour ajouter ...tu peux utiliser pour la description de tes classes méthodes et attributs cette forme

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
 
/**
 * description
 * 
 * @param type $monParam
 * @access public, privé...
 * @return type 
 */

c une convention largement utilisé en PHP et reconnue par les IDE (zend studio... lol)


-- tu as l'aire d'aimer la POO, passe a PHP5, pense à utiliser les constructeurs et destructeurs, donne l'accès nécessaire à tes attributs et méthodes, eviter un maximum un accès public à tes attributs, ton code sera plus lisible et portable, on fais pas de l'objet avec PHP4 de tte façon

[PseudoCoder]

Salut Sahid,

J'avais quand même précisé :

Je précise qu'il ne s'agit pas ici des commentaires du code : pour ma part, je n'ai pas encore choisi quel générateur de doc je vais utiliser (ni même si je vais en utiliser un). Mais cette question fera aussi l'objet d'une étude approfondie.

En ce qui me concerne, j'ai pris la décision de ne coder qu'en php5 : je n'ai en effet pas envie de me rendre les choses plus difficiles qu'elles ne le sont déjà en assurant une compatibilité php4 /5, surtout si je développe en POO au maximum.

Concernant le marqueur en fin de ligne, il y a deux écoles. Sur dvp.com, on peut lire qu'il vaut mieux commencer le bloc à la ligne suivante, pas sur la même ligne. Je pense que c'est plutôt une question de goût. Moi, je commence un bloc sur la ligne suivante :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
if ( $test )
{
  executeCode();
}

Voilà. Je pense que le tour de la question a été fait...

[sahid]

ah voui, désolé...

[pioule]

pas de

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
 
function truc()
{
    echo "bidule";
}

mais

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
 
function truc(){
    echo "bidule";
}

Moi aussi j'ai tendance plutôt à utiliser la première notation pour m'y retrouver plus facilement dans mon indentation, et aussi parce que je préfère voir

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
 
function truc()
{
}

plutôt que

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
 
function truc(){
}

quand la fonction est repliée
Enfin comme le dit PseudoCodeur, c'est plus une affaire de goût qu'une convention quelconque ^^

[elitemedia]

Quelle que soit la convention utilisée, il est important d'utiliser la même partout, même si c'est SA convention. Je crois qu'il n'y a pas vraiment de règle, comme je te l'ai dit PseudoCoder, il faut que ca TE convienne et que ca soit homogène et similaire dans tous tes scripts (Quitte à établir un document annexe décrivant tes choix de convention pour ton application)

Christophe

[PseudoCoder]

Re,

Oui, certes, il faut que ça me convienne.
L'objet de ma question, à l'origine, était d'avoir un retour d'autres développeurs, histoire de savoir comment chacun fait, pourquoi, histoire de m'orienter dans ma réflexion et d'arrêter des "standards" qui me conviennent, mais surtout qui soient susceptibles de convenir à d'autres personnes, puisque j'aimerais distribuer mon code...

En tout cas merci pour vos "témoignages"

[Petibidon]

En tout cas merci pour vos "témoignages"

bah de rien

maintenant le sujet est tellement vaste qu'il est difficile de répondre vraiment concretement à ce genre de question

tiens sinon pour la route, une autre habitude qui me fait risquer la lapidation mais je te la donne quand meme :

j'aime pas :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
 
class Trucmuche{
    private $machin;
    private $bidule;
    public $chose;
 
    function __construct(){
        $this->chose = array();
        ...
    }
    ...
}

j'aime :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
 
class Trucmuche{
    private $machin , $bidule;
    public $chose = array();
 
    function __construct(){
        ...
    }
    ...
}

si on dispose du minimum syndical pour coder, c'est à dire un logiciel qui colore la syntaxe, ca ne pose aucun probleme de lisibilité, et ca évite de se taper 36 fois la meme chose.

[PseudoCoder]

Dans le cas d'un code distribué, ce n'est pas vraiment recommandé, il me semble...
Autrement, si ça te convient, ça économise quelques lignes, en effet