Snippet

L’indentation consiste à ajouter des caractères (tabulations ou espaces) en début des lignes de votre code source afin d’en améliorer sa lisibilité.

Quand à la structure, celle-ci se voit soumise à des conventions diverses plus ou moins officielles.

Sur l’indentation tout d’abord :

L’indentation est l’action qui permet d’ajouter des caractères de tabulations ou d’espaces dans un fichier texte.

Source : Wikipédia

Sur ce sujet, il n’y a pas de consensus. Certains utilisent simplement les tabulations, d’autres (comme moi ) préfèrent utiliser les espaces (certains éditeurs de code remplacent automatiquement la touche tabulation par 4 espaces).

Sur la structure ensuite :

Celle-ci différent évidemment selon le langage.

Prenons par exemple le CSS et le PHP.

Car si certains préfèrent un affichage dans ce style :

.ma_classe {
    background-color:#fff;
    color:#000;
    padding:10px 5px;
}

D’autres non vue que sur le principe « sur une seule ligne » :

.ma_classe {background-color:#fff;color:#000;padding:10px 5px;}

Le point commun ? Classer les propriétés par ordre alphabétique. Ce n’est pas obligatoire, mais à l’utilisation, cela facilite la maintenance du code.

Pour le PHP, ça devient plus compliqué.

Certains organisme ont même « officialisé » LEURS conventions de codage.

Ainsi le ZEND FRAMEWORK possède ses propres règles d’écriture. Et ce sont celles-ci que j’applique dans mes développements.

• Indentation avec 4 espaces,
• déclaration d’un tableau avec un espace après chaque virgule,
• …

/**
* Documentation de la fonction
*/
public function bar()
{
    // contenu de la fonction
    // indenter avec 4 espaces

    // déclaration d'un tableau
    // avec un espace après chaque virgule
    $sampleArray = array(1, 2, 3, 'Zend', 'Studio');

    // déclaration d'une structure si alors sinon
    // les caractères { sont sur la même ligne que le if
    // un espace avant et après les conditions/affectations
    if ($a != 2) {
        $a = 2;
    } else {
        $a = 7;
    }
}

Bon je ne les énumère pas tous parce qu’il y en à pour absolument tout !

A ces règles, je rajoute ma petite touche personnelle : commencer mes variables avec une lettre spécifiant son type.

• $aArray : déclaration de tableau
• $sString : déclaration d’une chaîne
• $iInteger : déclaration d’un entier
• …

Bon, c’est mon petit truc en plus. Je pense que chaque développeur aime bien SA propre méthode de codage. Je pense cependant qu’il est nécessaire d’uniformiser au plus son code source, ne serais-ce qu’en pensant aux personnes qui le reliront…

Lien :

• Convention de codage PHP de Zend Framework