Comment insérer des commentaires ?
Les langages de programmation proposent une notation pour insérer des commentaires dans le code, c'est-à-dire du texte qui va être ignoré par l'ordinateur. Les commentaires peuvent servir à expliquer une partie compliquée d'un programme, ou à mettre des indications dans le code, comme son auteur ou sa date.
En Python, on insère un commentaire avec le caractère # (un dièse). Voici un exemple :
# Ce programme a été écrit par gcworks le 01/01/2023 # Affiche un rectangle rempli de X for loop in range(5): for loop in range(10): print("X") # commentaire possible sur une ligne print() |
La priorité est toujours d'écrire le code le plus clair possible. Il est très souvent bien plus efficace de comprendre un programme directement à partir de ses instructions, qu'en alternant la lecture des instructions avec celle d'explications spécifiques.
N'utilisez donc de commentaires que lorsque cela s'avère nécessaire, une fois que vous avez travaillé la clarté de votre code au maximum.
Créé avec HelpNDoc Personal Edition: Générateur complet de livres électroniques Kindle