Commentaires en ligne
Leçon 7 sur 28 du cours Clean Code - Écrire un meilleur code avec Python de Coddy.
Les commentaires en ligne expliquent une seule instruction dans un morceau de code.
- Écris les commentaires en ligne sur la même ligne que l’instruction à laquelle ils se rapportent.
- Sépare les commentaires en ligne de l’instruction par au moins deux espaces.
- Commence par un
#et un espace. - Ne les utilise pas pour expliquer ce qui est évident.
Par exemple,
result = check(name) # Vérifie si name est bonLa plupart du temps, tu préféreras utiliser des blocs de commentaires plutôt que des blocs en ligne.
Défi
FacileOn vous donne un petit code qui effectue un petit calcul pour augmenter le salary ; écrivez un commentaire en ligne qui explique cette ligne.
Il s’agit probablement d’une explication évidente, mais pour les besoins de notre exercice, nous allons le faire...
Essayez vous-même
salary = 1000
salary = salary * 1.05Toutes les leçons de Clean Code - Écrire un meilleur code avec Python
Entraînez-vous par vous-même : Compilateur Python en ligne