Indentez votre code



Une des premières choses qui saute aux yeux quand on regarde un code source, c'est son indentation.

Le principe de l'indentation, c'est d'utiliser intelligemment les tabulations pour « décaler » certaines parties de votre code afin de montrer plus clairement la structure.


La quasi-totalité des éditeurs de texte ont l'habitude que vous utilisiez du code indenté, et vous aident donc beaucoup à clarifier votre code.


Quand je dis « la plupart », je ne parle pas de Bloc-notes. Si vous tapez votre code PHP dans Bloc-notes, vous feriez bien d'essayer un vrai logiciel fait pour ça, comme Notepad++ dont je vous ai parlé dans un des premiers chapitres.


Non seulement avec un vrai éditeur vous avez une indentation du code semi-automatique, mais en plus votre code est automatiquement coloré, ce qui aide énormément, croyez-moi !


Il y a plusieurs « styles » d'indentation de code ; cela varie un peu selon les goûts des développeurs. Celui que je vous propose est simple à retenir :

  • chaque fois que vous ouvrez des accolades {, par exemple pour un if, un while ou un for, vous décalez tout le code qui suit d'une tabulation vers la droite ;
  • chaque fois que vous fermez une accolade }, vous décalez tout le code qui suit d'une tabulation vers la gauche.

Avec un code non indenté


C'est plus clair avec un exemple, alors voyez vous-mêmes. Voici ce que ça donne avec un code non indenté :

<?php

for ($ligne = 1 ; $ligne <= 100 ; $ligne++)

{

if ($ligne % 2 == 0)

{

echo $ligne . ' : <strong>ligne paire</strong>';

}

else

{

echo $ligne . ' : <em>ligne impaire</em>';

}

echo '<br />';

}

?>


Avec un code indenté


Et voici maintenant le même code correctement indenté si on respecte la règle des tabulations :

<?php

for ($ligne = 1 ; $ligne <= 100 ; $ligne++)

{

    if ($ligne % 2 == 0)

    {

        echo $ligne . ' : <strong>ligne paire</strong>';

    }

    else

    {

        echo $ligne . ' : <em>ligne impaire</em>';

    }

     

    echo '<br />';

}

?>

L'avantage avec un code indenté, c'est qu'on voit bien les « niveaux » des instructions. On sépare bien les blocs, et on arrive à se repérer bien plus facilement. ;-)


Avoir un code correctement indenté est quasiment indispensable lorsque vous commencez à faire des scripts de plusieurs dizaines de lignes (ce qui arrive assez vite !).


Certains développeurs ont tendance à remplacer les tabulations par deux ou quatre espaces, car la largeur d'une tabulation peut varier d'un logiciel à un autre, alors que celle d'un espace est fixe. En général, c'est l'éditeur de texte lui-même qui convertit nos tabulations par des espaces, de façon transparente.

Créé avec HelpNDoc Personal Edition: Analyseur de projet de HelpNDoc : incroyable assistant de documentation