Commenter son code

Afin de rendre votre programme plus clair, il est nécessaire, dès que votre code dépasse une dizaine de lignes, d'introduire des commentaires. Bien sûr cela peut permettre à une personne qui n'a pas écrit le programme de comprendre ce que vous avez voulu faire, mais cela peut aussi vous permettre, quelques mois après avoir terminé d'écrire votre code, de vous "rafraîchir la mémoire".

En Python, toute ligne commençant par le caractère dièse (#) sera considérée comme un commentaire par le système interpréteur/compilateur.

Voici un exemple de programme commenté :

1
# la fonction monMessage permet d'afficher un message
2
#****************début de la fonction monMessage******************
3
def monMessage(nom):
4
	return f"Bonjour {nom}"
5
#****************fin de la fonction monMessage********************
6
# interrogation de l'utilisateur
7
monNom=input("Quel est votre nom ? ")
8
# appel de la fonction monMessage
9
msg=monMessage(monNom)

Attention, dans l'exemple ci-dessus j'ai volontairement alourdi le programme avec des commentaires inutiles vu la simplicité de ce dernier.