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.
- Écrivez les commentaires en ligne sur la même ligne que l'instruction à laquelle ils se rapportent.
- Séparez les commentaires en ligne par deux espaces ou plus de l'instruction.
- Commence par un
#et un seul espace. - Ne les utilisez pas pour expliquer l'évidence.
Par exemple,
result = check(name) # Vérifier si le nom est correctLa plupart du temps, vous préférerez utiliser des blocs de commentaires au lieu de 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.
C'est probablement une explication évidente, mais pour les besoins de notre pratique, nous allons le faire...
Essayez vous-même
salary = 1000
salary = salary * 1.05