diff --git a/README.md b/README.md index dd51e0d..46fecc8 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,14 @@ Les noms sont choisis de manière explicite et descriptive afin de faciliter la ### 2. Les commentaires +Nous avons fait le choix de limiter l’utilisation des commentaires dans le code. En effet, nous privilégions un code clair, lisible et auto-documenté, notamment grâce à : +- un nommage explicite des variables, fonctions et classes +- l’utilisation du typage lorsque cela est possible +- une structure de projet organisée +- une documentation externe (README, Storybook, Bruno) + +Les commentaires sont donc utilisés uniquement lorsque cela apporte une réelle valeur ajoutée, par exemple pour expliquer une logique complexe, un choix technique spécifique ou un comportement non évident. + ### 3. La documentation La documentation du projet est assurée à plusieurs niveaux :