Introduction aux commentaires et à la lisibilité du code

Les commentaires servent à expliquer le code et à le rendre plus lisible. L'interpréteur Python les ignore et ils n'ont aucun effet sur l'exécution du programme.

Dans cette leçon, vous apprendrez à utiliser des commentaires et à écrire du code propre et lisible.

Commentaires sur une seule ligne

Les commentaires sur une seule ligne commencent par un #. Tout ce qui suit le # sur cette ligne est ignoré par Python. Par exemple :

# This is a single-line comment
print("Hello, World!")

Commentaires multilignes

Les commentaires multilignes peuvent être écrits à l'aide de triples guillemets (''' ou """). Par exemple :

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Pourquoi utiliser des commentaires ?

Les commentaires permettent :

• D'expliquer du code complexe.
• De rendre le code plus facile à comprendre pour les autres et pour vous-même à l'avenir.
• De déboguer et de résoudre des problèmes.

N'oubliez pas : les commentaires sont destinés aux humains, pas à la machine !

Bonnes pratiques pour les commentaires

Voici quelques conseils pour rédiger de bons commentaires :

• Rédigez des commentaires concis et pertinents.
• Évitez les commentaires évidents comme # Increment x by 1 pour x = x + 1.
• Utilisez les commentaires pour expliquer pourquoi le code est écrit d'une certaine manière.

Améliorer la lisibilité du code

Un code lisible est plus facile à maintenir et à déboguer. Voici quelques conseils :

• Utilisez des noms de variables et de fonctions pertinents.
• Gardez les lignes de code courtes.
• Organisez le code en sections à l'aide de commentaires.

Désactiver du code avec des commentaires

Vous pouvez utiliser des commentaires pour désactiver temporairement du code à des fins de débogage. Par exemple :

# print("This line is commented out and won’t run.")
print("This line will run.")

Exemple : documenter une fonction

Vous pouvez utiliser des commentaires pour documenter des fonctions et expliquer leur objectif :

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

Qu'avons-nous appris ?

Dans cette leçon, vous avez appris :

• Comment écrire des commentaires sur une seule ligne et des commentaires multilignes en Python.
• L'importance des commentaires pour la lisibilité et la maintenabilité du code.
• Les bonnes pratiques pour rédiger des commentaires et améliorer la lisibilité du code.

Excellent travail ! Passons au sujet suivant.