Giovanni/SAE-BUT2-docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add comments part in README

Browse Source
This commit is contained in:
Giovanni
2026-03-29 18:42:22 +02:00
parent 9d552ed723
commit fee69cea89
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8
View File
@@ -95,6 +95,14 @@ Les noms sont choisis de manière explicite et descriptive afin de faciliter la
### 2. Les commentaires ### 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 ### 3. La documentation
La documentation du projet est assurée à plusieurs niveaux : La documentation du projet est assurée à plusieurs niveaux :