Magazine High tech

Quelques conventions d'écriture avec PHP

Publié le 07 novembre 2007 par Dave Lizotte

Indentation et longueur de lignes


Utilisez une indentation de 4 espaces, sans tabulationis.
Il est recommandé que la longueur des lignes ne dépasse pas 75 à 85 caractères. Il n’y a pas de règles fixes par rapport aux retours à la ligne, mais vous pouvez utiliser votre bon jugement. En cas de doutes, vous pouvez toujours demander sur la liste de diffusion PEAR Quality Assurance

Structures de Contrôles

Les structures de contrôles incluent les if, for, while, switch, etc. Vous trouverez ici un exemple de structure if qui est la plus compliquée :
 
       if ((condition1) || (condition2)) {
           action1;
       } elseif ((condition3) & (condition4)) {
         action2;
       } else {
         defaultaction;
       }       
       
Les instructions de contrôle doivent avoir un espace entre le mot clé de l’instruction et la parenthèse ouvrante, afin de les distinguer des appels de fonctions.

Il est vivement recommandé de toujours utiliser des accolades, même dans les situations où elles sont techniquement optionnelles. Leur présence augmente la lisibilité du code et réduit le risque d’erreur logique lors de l’ajout de nouvelles lignes de code.

Pour l’instruction switch :
       switch (condition) {
         case 1:
         action1;
       break;
       
       case 2:
         action2;
       break;
       
       default:
         defaultaction;
       break;
       }       
     

Appels de Fonctions

Les fonctions doivent être appelées sans espace entre le nom de la fonction, la parenthèse ouvrante, et le premier paramètre ; avec un espace entre la virgule et chaque paramètre et aucun espace entre le dernier paramètre, la parenthèse fermante et le point virgule. Voici un exemple :
 
       $var = foo($bar, $baz, $quux);
       
Comme montré ci-dessus, il doit y avoir un espace de chaque côté du signe égal utilisé pour affecter la valeur de retour de la fonction à une variable. Dans le cas d’un bloc d’instructions similaires, des espaces supplémentaires peuvent être ajoutés pour améliorer la lisibilité :
       $short   = foo($bar);
       $long_variable = foo($baz);
       

Définitions des fonctions

La déclaration des fonctions respecte l’indentation classique des accolades :
       function fooFunction($arg1, $arg2 = '')
       {
           if (condition) {
            statement;
           }
         return $val;
       }       
       
Les arguments possédant des valeurs par défaut vont à la fin de la liste des arguments. Il faut toujours chercher à retourner une valeur ayant un sens lorsque cela est possible. Voici un exemple un peu plus long :

       function connect(&$dsn, $persistent = false)
       {
         if (is_array($dsn)) {
            $dsninfo = &$dsn;
         } else {
            $dsninfo = DB::parseDSN($dsn);
         }
        
         if (!$dsninfo || !$dsninfo['phptype']) {
            return $this->raiseError();
         }
       
           return true;
       }
       

Retour à La Une de Logo Paperblog

A propos de l’auteur


Dave Lizotte 57 partages Voir son profil
Voir son blog

l'auteur n'a pas encore renseigné son compte l'auteur n'a pas encore renseigné son compte

Dossier Paperblog