|
Les notes qui documentent les lignes ou les sections d'un programme sont appelées commentaires .
Les commentaires sont des notes explicatives dans le code source d'un programme qui sont ignorées par le compilateur ou l'interpréteur. Ils sont uniquement destinés aux lecteurs humains afin de mieux comprendre le code. Différents langages de programmation utilisent une syntaxe différente pour les commentaires :
* Commentaires sur une seule ligne : Ceux-ci commentent une seule ligne de code. Les exemples incluent :
* `// Il s'agit d'un commentaire sur une seule ligne en C++, Java, JavaScript et bien d'autres.`
* `# Ceci est un commentaire sur une seule ligne en Python, Ruby et Bash.`
* Commentaires multilignes (bloquer les commentaires) : Ceux-ci commentent plusieurs lignes de code. Les exemples incluent :
* `/* Il s'agit d'un commentaire multiligne en C, C++, Java et autres.
Il peut s'étendre sur plusieurs lignes. */`
* ``'' Il s'agit d'un commentaire multiligne en Python.
Il peut également s'étendre sur plusieurs lignes. '''`
* `""" Ceci est un autre style de commentaire multiligne en Python. """`
Le but des commentaires est de :
* Expliquez le but du code : Décrivez ce que fait une fonction, une classe ou un bloc de code.
* Clarifier la logique complexe : Décomposez les algorithmes ou les étapes complexes en parties plus petites et compréhensibles.
* Hypothèses et limites du document : Notez toutes les contraintes ou conditions dans lesquelles le code fonctionne.
* Fournir le contexte : Expliquez le raisonnement derrière certains choix de conception.
* Laisser des notes pour les modifications futures : Aidez les autres (ou vous-même à l’avenir) à comprendre et à maintenir le code plus facilement.
Des commentaires bien rédigés sont cruciaux pour la lisibilité, la maintenabilité et la collaboration du code. Les commentaires excessifs (commenter du code évident) sont généralement déconseillés, car cela peut encombrer le code et le rendre plus difficile à lire. L'objectif est d'ajouter de la valeur à la compréhension du code, et non de reformuler ce qui est déjà clair.
|
