Conventions de codage

Lorsque nous travaillons sur nos conventions de codage, nous devons au préalable bien connaître et maîtriser les conventions du langage spécifique que nous utilisons.

C’est la raison pour laquelle je me suis appuyé principalement sur la documentation officielle mdBook afin de produire le code source de ce « livre ».

Le langage Markdown dispose d’un certains nombres de possibilités afin de réaliser les mêmes choses.

Par exemple, nous pouvons utiliser soit * soit - pour identifier un élément d’une liste.

Ici, le choix a été simple : il m’a été dicté par la documentation officielle mdBook qui propose d’utiliser le *.

Il est préférable d’inclure cette convention de codage dans notre référentiel afin de nous en souvenir et de l’appliquer de manière homogène.

Bien que mdBook s’appuie sur le langage Markdown, il est possible que le compilateur mdBook que nous utilisons se comporte différemment d’un autre compilateur dans un autre environnement.
Appliquer les mêmes conventions dès le début et pour tous nos projets nous préserve de mauvaises surprises.