Python - Comments: A Beginner's Guide (Français)

Bonjour à tous, futurs maîtres Python! Aujourd'hui, nous allons plonger dans un sujet qui peut sembler mineur mais est incroyablement important dans le monde de la programmation : les commentaires. En tant que votre enseignant de quartier en informatique, je suis là pour vous guider à travers les ficelles des commentaires Python. Alors, prenez vos block-notes virtuels, et c'est parti !

Qu'est-ce qu'un commentaire Python ?

Avant de plonger dans le détail, voyons ce qu'entend-on par commentaire. Imaginez que vous écrivez une recette pour votre futur vous. Vous ajouteriez probablement des petites notes comme "Ingédient secret de maman" ou "Fouetter jusqu'à ce qu'il ressemble à une galaxie en spirale". C'est exactement ce que sont les commentaires en programmation – de petites notes que nous laissons pour nous-mêmes et les autres pour mieux comprendre notre code.

En Python, les commentaires sont des lignes de texte que l'interpréteur Python ignore complètement lors de l'exécution de votre code. Ils ne sont là que pour les yeux humains !

Commentaires sur une seule ligne en Python

Commençons par la forme la plus simple des commentaires : les commentaires sur une seule ligne.

Les Bases

En Python, vous pouvez créer un commentaire sur une seule ligne en utilisant le symbole dièse (#). Tout ce qui suit le # sur cette ligne est considéré comme un commentaire.

# C'est un commentaire sur une seule ligne
print("Bonjour, Monde !")  # C'est aussi un commentaire, mais après du code

Dans cet exemple, la première ligne est entièrement un commentaire. La deuxième ligne contient du code suivi d'un commentaire. Python exécutera uniquement la partie print("Bonjour, Monde !").

Exemple concret

Regardons un exemple plus pratique :

# Calculer l'aire d'un rectangle
longueur = 10  # Longueur en mètres
largeur = 5   # Largeur en mètres
aire = longueur * largeur  # Formule : Aire = longueur * largeur
print(f"L'aire du rectangle est de {aire} mètres carrés")

Ici, nous utilisons des commentaires pour expliquer ce que fait chaque ligne. C'est particulièrement utile lorsque vous apprenez ou lorsque votre code devient plus complexe.

Conseil de pro

Je dis toujours à mes étudiants : "Commentez comme si la personne qui lit votre code était un psychopathe violent qui sait où vous vivez." C'est un peu dramatique, mais cela fait comprendre le point – des commentaires clairs peuvent vous (ou quelqu'un d'autre) éviter de nombreux maux plus tard !

Commentaires sur plusieurs lignes en Python

Maintenant, que faire si vous voulez écrire un commentaire qui s'étend sur plusieurs lignes ? Python n'a pas de syntaxe spécifique pour les commentaires sur plusieurs lignes, mais nous avons un joli truc sous le coude.

Utiliser les triple guillemets

Nous pouvons utiliser des triple guillemets (''' ou """) pour créer des chaînes de caractères sur plusieurs lignes, qui peuvent effectivement servir de commentaires sur plusieurs lignes :

'''
C'est un commentaire sur plusieurs lignes.
Il peut s'étendre sur plusieurs lignes.
Python l'ignore lors de l'exécution.
'''

"""
C'est un autre moyen d'écrire
un commentaire sur plusieurs lignes en utilisant
des guillemets doubles.
"""

print("Le code continue ici")

Les deux de ces méthodes créent des chaînes de caractères qui ne sont pas assignées à aucune variable, donc Python les ignore effectivement. C'est un peu une astuce, mais cela fonctionne magnifiquement !

Quand utiliser les commentaires sur plusieurs lignes

Les commentaires sur plusieurs lignes sont伟大的 pour :

1. Expliquer des algorithmes complexes
2. Fournir un aperçu d'une fonction ou d'une classe
3. Désactiver temporairement de grandes parties de code (mais soyez prudent avec cela !)

Voici un exemple plus détaillé :

def calculer_fibonacci(n):
"""
Cette fonction calcule le nième nombre de la suite de Fibonacci.

La suite de Fibonacci est définie comme suit :
F(n) = F(n-1) + F(n-2), où F(0) = 0 et F(1) = 1

Paramètres :
n (int): La position dans la suite de Fibonacci à calculer

Retourne :
int: Le nième nombre de Fibonacci
"""
if n <= 1:
return n
else:
return calculer_fibonacci(n-1) + calculer_fibonacci(n-2)

# Exemple d'utilisation
print(calculer_fibonacci(10))

Dans cet exemple, nous utilisons un commentaire sur plusieurs lignes (nommé docstring en Python) pour expliquer ce que fait la fonction, comment elle fonctionne et quels paramètres elle attend. C'est extrêmement utile pour les besoins de documentation.

Utiliser les commentaires pour la documentation

Les commentaires ne servent pas seulement à expliquer votre code ; ils sont également cruciaux pour la documentation. Une bonne documentation peut transformer un bon programmeur en un excellent programmeur !

Docstrings

Nous avons déjà vu un exemple de docstring ci-dessus. En Python, la première chaîne de caractères après la définition d'une fonction, d'une classe ou d'un module est appelée une docstring. C'est un type spécial de commentaire qui peut être accessible de manière programmatique.

def saluer(nom):
"""
Cette fonction salue la personne passée en tant que paramètre.

Paramètres :
nom (str): Le nom de la personne à saluer

Retourne :
str: Un message de salutation
"""
return f"Bonjour, {nom} ! Comment ça va aujourd'hui ?"

# Vous pouvez accéder à la docstring comme ceci :
print(saluer.__doc__)

Commentaires en ligne

Parfois, un commentaire en ligne rapide peut sauver la journée :

resultat = x * 5 + y / 2 - z  # Utilisation de la formule spéciale de la page 42

Ce type de commentaire peut être inestimable lorsque vous traitez des calculs ou algorithmes complexes.

Meilleures pratiques pour l'utilisation des commentaires

Faisons un résumé avec quelques règles d'or pour l'utilisation des commentaires :

Règle	Description	Exemple
Soyez clair	Écrire des commentaires qui expliquent 'pourquoi', pas seulement 'quoi'	# Incrémenter i pour éviter la boucle infinie
Gardez-le à jour	Mettez toujours à jour les commentaires lorsque vous modifiez de code	# Utilisation de l'algorithme amélioré (v2.0)
Ne dites pas l'évident	Évitez les commentaires qui n'ajoutent pas de valeur	❌ x = x + 1 # Ajouter 1 à x
Utilisez une bonne grammaire	Traitez les commentaires comme n'importe quel autre texte écrit	# Calculer la moyenne des valeurs d'entrée
Commentez les parties complexes	Concentrez-vous sur les bits difficiles de votre code	# Gérer le cas limite lorsque l'entrée est vide

N'oubliez pas, l'objectif des commentaires est de rendre votre code plus compréhensible. Comme l'a dit un de mes étudiants un jour, "De bons commentaires sont comme un bon calembour – si vous devez les expliquer, ils ne sont probablement pas si bons !"

En conclusion, maîtriser l'art d'écrire de bons commentaires est une compétence cruciale pour tout programmeur. Cela non seulement aide les autres à comprendre votre code, mais vous-aussi lorsque vous revenez à votre code mois ou années plus tard. Bonne commentaire, et que votre code soit toujours clair et compréhensible !

Credits: Image by storyset