Conventions de nommage

Les conventions de nommage concernent les différents objets qui sont manipulés en développement.

Dans le cadre d’un projet mdBook, cela se résume à convenir de règles pour donner des noms à :

• des dossiers :
  • le dossier du projet mdBook lui-même ;
  • les différents sous-dossiers du dossier nom-du-projet/src (par défaut) ;
• des fichiers :
  • fichiers.md (sources de nos pages mdBook) ;
  • images ;
  • codes sources ;
  • etc.

Ces conventions de nommage peuvent préciser les règles qui s’appliquent pour le classement d’un certain nombre de fichiers et de dossiers, le nom complet étant par exemple :

nom-du-projet/NomDeLaRubriqueDuSommaireMdbook/nom_de_la_page_mdbook.md

Bien entendu, ces conventions de nommage prennent en considération les règles de fonctionnement de mdBook.

Petite anecdote au sujet des conventions de nommage

J’ai choisi de ne pas utiliser des caractères accentués.
C’est un choix qui pouvait coûter cher et qui peut encore coûter cher en développement et la plupart des développeurs savent qu’il vaut mieux ne pas sortir des codes ASCII de base.

Plus tôt dans ma jeunesse, j’ai un jour travaillé à développer un code informatique de gestion commerciale dans un environnement bureautique. ¹ Le développement en lui-même n’était pas complexe mais des suites d’un choix de nommage d’un seul des dossiers, le comportement de mon code semblait TOTALEMENT ALÉATOIRE !!!

Cela m’a fait perdre beaucoup de temps et m’a causé beaucoup de tracas inutiles : je ne risque pas de l’oublier.

En conclusions :

1. ne sous-estimons jamais l’impact de ce qui peut ressembler de loin à des détails tatillons ;
2. ici l’enjeu est faible, mais il importe de toujours être bien conscient·e·s de toutes les conséquences de tel ou tel choix que nous faisons.

1. Oui, déjà, en 1995, il y a plus de 30 ans, les entreprises du CAC 40 étaient ultra-dépendantes aux outils commerciaux de l’oncle Mickey (et se rendaient quotidiennement plus dépendantes encore, de leur plein gré). ↩