Un code propre et bien documenté est essentiel pour maintenir et partager vos projets. Dans cet exercice, vous pratiquerez l'une des habitudes les plus importantes des développeurs professionnels : écrire des commentaires clairs et utiles qui expliquent le but et le fonctionnement de votre code.
Passez en revue votre fichier app.js actuel dans votre dossier de jeu, et trouvez des moyens de le commenter et de le ranger. Il est très facile que le code devienne difficile à gérer, et c’est une bonne occasion d'ajouter des commentaires pour vous assurer que votre code est lisible afin de pouvoir l'utiliser plus tard.
Votre tâche inclut :
- Ajouter des commentaires expliquant ce que fait chaque section majeure du code
- Documenter les fonctions avec des descriptions claires de leur objectif et de leurs paramètres
- Organiser le code en blocs logiques avec des en-têtes de section
- Supprimer tout code inutilisé ou redondant
- Utiliser des conventions de nommage cohérentes pour les variables et les fonctions
| Critères | Exemplaire | Adéquat | Doit être amélioré |
|---|---|---|---|
| Documentation du Code | Le code app.js est entièrement commenté avec des explications claires et utiles pour toutes les sections et fonctions majeures |
Le code app.js est suffisamment commenté avec des explications basiques pour la plupart des sections |
Le code app.js a très peu de commentaires et manque d’explications claires |
| Organisation du Code | Le code est organisé en blocs logiques avec des en-têtes de section clairs et une structure cohérente | Le code a une certaine organisation avec un regroupement basique des fonctionnalités liées | Le code est quelque peu désorganisé et difficile à suivre |
| Qualité du Code | Toutes les variables et fonctions ont des noms descriptifs, aucun code inutilisé, suit des conventions cohérentes | La plupart du code suit de bonnes pratiques de nommage avec un minimum de code inutilisé | Les noms des variables ne sont pas clairs, contient du code inutilisé, style incohérent |
Clause de non-responsabilité :
Ce document a été traduit à l'aide du service de traduction automatique Co-op Translator. Bien que nous nous efforcions d'assurer la précision, veuillez noter que les traductions automatiques peuvent contenir des erreurs ou des inexactitudes. Le document original dans sa langue natale doit être considéré comme la source faisant foi. Pour les informations critiques, une traduction professionnelle réalisée par un humain est recommandée. Nous déclinons toute responsabilité en cas de malentendus ou de mauvaises interprétations résultant de l'utilisation de cette traduction.