Ce bloc-notes mdBook vous est proposé avec passion par Marc JESTIN — Happy Numeric.
À votre service pour vous accompagner dans vos projets numériques.
Contact : https://happynumeric.fr/me-contacter.

Conventions de codage

Lorsque nous nous lançons dans la création d'un projet mdBook, il est préférable d'appliquer des conventions afin d'augmenter notre productivité et d'améliorer l'homogénéité et la lisibilité de nos supports.

Il existe plusieurs conventions qui sont importantes au premier rang desquelles :

• les conventions de nommage ;
• les conventions de codage ;
• les conventions d'écriture.

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 ce Bloc-notes mdBook.

Le langage Markdown disposer 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 se comporte différemment d'un autre compilateur dans un autre environnement.

N'hésitez pas à me faire votre feedback, me signaler des erreurs ou des compléments que vous souhaiteriez que j'ajoute à ce bloc-notes mdBook.
Cliquez ici pour me contacter

À propos de cette page

Création : 14 mars 2023

Dernière mise à jour : 21 mars 2023 22:29