Conventions de développement

Il est important dans un projet que les développeurs adoptent un style de développement identique. Ceci favorise la relecture du code et le débogage.

Ces règles n'est pas obligatoire, mais très fortement recommandée pour vos développements.

Indentation



Le style d'indentation adopté sur PHPBoost permet de gagner en lisibilité et en clarté du code.
L'utilisation des tabulations et des espaces est très importante dans le code. Il faut aérer votre code pour le rendre plus lisible.

Nous allons voir plusieurs exemple ci-dessous.


Les conditions



Un espace avant la parenthèse. Les accolades ne sont pas sur la même ligne que la condition.
Il faut indenter le code.

Conditions simples



Code PHP :
if ($var == 2)
{
    echo 'La variable vaut 2';
}


Traitement sur plusieurs lignes



Code PHP :
if ($var == 2)
{
    echo 'test';
}
elseif ($var == 3)
{
    echo 'La variable vaut 3';
}
else
{
    echo 'La variable ne vaut ni 2, ni 3';
}


Avec imbrication



Code PHP :
if ($var > 0)
{
    if ($var == 2)
    {
        echo 'test';
    }
    elseif ($var == 3)
    {
        echo 'La variable vaut 3';
    }
    else
    {
        echo 'La variable ne vaut ni 2, ni 3';
    }
}


Il s'agit donc d'indenter le code et non la partie déclarative.


Les boucles



Code PHP :
for ($i = 0; $i < 5; $i++)
{
    echo $i;
}


Code PHP :
$i = 0;
while ($i < 5)
{
    echo $i;
    $i++;
}



Les variables



Par convention, toutes les variables, y compris les variables de classes, doivent commencer par une minuscule.

Si la variable est une suite de mots, ils devront être séparés d'un tiret bas ou underscore (_).

Exemple :

Code PHP :
$ma_variable


Les classes



Les classes ont également un traitement particulier en terme de convention.


Nommage




Les classes doivent toujours commencer par une majuscule :

Code PHP :
class Class
{
 
}


Si la classe est une suite de mot, chaque mot commence par une majuscule et ne sera séparé d'aucune manière :

Code PHP :
class MyClass
{
 
}



Les fonctions



Les fonctions doivent être en minuscule avec un underscore entre chaque mot.

Code PHP :
class MyClass
{
    private $name = 'PHPBoost';
 
    public function get_name()
    {
        return $this->name;
    }
}
Cette page a été vue 2294 fois