 |
Fiche mémo |
Février 2019 |
Un petit rappel pour les débutants sur l'indentation du code, on voit trop souvent du code sur internet
que je qualifierais de "fouillis" c'est bien dommage car il est peut-être très bon, mais on a pas envie de le lire.
Un autre point est la coloration syntaxique du code que permettent les éditeurs simplement en leur précisant
le type de langage utilisé alors ne vous en privé pas mettez de la couleur dans votre code non pas pour le coté
graphique mais bien pour la compréhension.
Sur l'illustration ci-contre vous pouvez voir une indentation de base.
Le code de la fonction est décalé sur la droite de l'équivalent de 5 espaces (une tabulation).
Les choix de l'instruction switch sont eux décalés de 5 espaces sur la droite (une tabulation).
Bien sur si on ne met pas ses décalages dans le code cela ne l'empêche pas de fonctionner !
Mais la lisibilité et la compréhension en sont diminuées.
La coloration du code nous permet d'identifier quatre types de mots :
Si un seul langage était utilisé il serait facile d'indenter son code mais souvent et notamment lors du développement de page web
on est amené à utiliser plusieurs langages dans la même page. Il faut donc décider d'une norme qui vous satisfait au mieux,
mais l'idéal est bien sur de s'y tenir !
Sur une page web les langages suivants cohabitent souvent :
Attention il faut bien garder en tête que l'indentation n'est là que pour structurer la présentation du code dans le but d'en faciliter sa lecture et sa relecture !
Mais en aucun cas elle ne structure le code lui-même !!!
Un exemple d'une erreur de codification par économie d'accolade, quand on regarde le code la mauvaise indentation a tendance à masquer l'erreur,
il la cache tellement bien qu'elle peut être difficile à identifier :
Il est courant aujourd'hui de séparer le code d'une page web en plusieurs fichier pour en améliorer la lisibilité.