Commentaires

Pour un programmeur sérieux, les commentaires sont extrêmement importants même s’ils ne changent rien à l’exécution du programme. Les commentaires permettent de structurer un programme et de laisser des indications sur son fonctionnement. Il est ainsi plus facile d’en comprendre le fonctionnement pour une personne tierce ou plusieurs mois plus tard pour l’auteur.

Les commentaires en Python commencent par le signe dièse (#). Ils peuvent être en début ou milieu de ligne.

a = 2
# Ceci est un commentaire
b = 3 # Ceci est un autre commentaire

Vous devrez absolument mettre des commentaires dans votre code. Ils sont là pour expliquer le fonctionnement de votre programme ou éventuelement des choix que vous avez fait. Ils peuvent être des notes pour vous-même ou pour un autre programmeur. Cela fera partie de votre évaluation.

Nous verrons un peu plus loin les docstrings qui sont des commentaires spécifiques aux fonctions et aux classes. Mais leur but est toujours d'expliquer le fonctionnement du programme.