À quoi sert un commentaire ? - Docstring

À quoi sert un commentaire ?

Les commentaires servent à décrire ce qui se passe dans votre code.

Pensez aux personnes qui passeront derrière vous !

Prendre le temps d'expliquer votre code fera gagner beaucoup de temps à tout le monde, y compris à vous.

En Python, on utilise le symbole # pour démarrer l'écriture d'un commentaire :

# Affiche tous les chiffres pairs compris entre 0 et 10
def print_modulo():
    for i in range(10): 
        if i % 2 == 0: 
            print(i)

print_modulo()

Toutes les lignes qui commencent par le symbole # ne seront ainsi pas interprétées par Python.

Vous pouvez ainsi utiliser ce symbole également pour éviter d'interpréter une ligne de façon momentanée, plutôt que de la supprimer.

Vous pouvez juste utiliser un # au début de chaque ligne :

# Premier commentaire
# Deuxième commentaire
# Troisième commentaire

Mais je vous conseille plutôt d'utiliser les triples apostrophes ''' ou les triples guillemets """ qui sont dédiées à cet usage :

''' Affiche tous les chiffres pairs
compris entre 0 et 10 '''
def print_modulo():
    for i in range(10): 
        if i % 2 == 0: 
            print(i)

print_modulo()

 

Réservé aux membres abonnés

Inscris-toi

Pour pouvoir prendre des notes et ajouter des favoris tu dois être abonné à Docstring.

Voir les formules

Mes notes

Sauvegardé

Passages surlignés

Besoin d'aide ?

Essaie d'être le plus exhaustif possible en donnant suffisamment de détails pour qu'on puisse te répondre du premier coup 😉

Tu peux également visionner cette vidéo dans laquelle je t'explique comment poser ta question correctement et utiliser l'éditeur.

Tu souhaites nous remonter un bug ? Utilise-plutôt ce formulaire.

Cette fonctionnalité est réservée aux membres de la formule accompagnement de Docstring.

Aucun résultat.

Un problème sur le site ?

Aide-nous à améliorer Docstring en nous signalant un problème que tu as rencontré.

Que ce soit un bug sur une fonctionnalité ou une erreur dans une formation, on va pouvoir le corriger rapidement 😉

Page concernée

M'avertir par e-mail

Je veux être averti par e-mail lorsque ce bug est corrigé.