Commentaires de bloc
Leçon 6 sur 28 du cours Clean Code - Écrire un meilleur code avec Python de Coddy.
« Si l’implémentation est difficile à expliquer, c’est une mauvaise idée. »
- Le Zen de Python
Les commentaires sont importants afin que toute personne qui lira votre code puisse le comprendre.
Les commentaires en Python se répartissent en 3 catégories :
- Commentaires de bloc
- Commentaires en ligne
- Chaînes de documentation
Commençons par les Commentaires de bloc -
- Commencent avec le même niveau d’indentation que le bloc de code qu’ils décrivent.
- Commencez chaque ligne par un
#suivi d’une seule espace.
Par exemple,
while i < 10:
# Boucle sur i jusqu'à i < 10
# affiche i avec une nouvelle ligne et l'incrémente de 1
print(i, '\n')
i += 1
Défi
FacileLa fonction greet vous est donnée : écrivez un commentaire de bloc pour décrire ce que fait cette fonction, avec vos propres mots.
Suivez les règles !
Essayez vous-même
def greet(name):
print('Hello', name)Toutes les leçons de Clean Code - Écrire un meilleur code avec Python
Entraînez-vous par vous-même : Compilateur Python en ligne