Introduction : L’importance des commentaires dans le code :

Avant de continuer sur notre programme, je vais vous parler d’une notion importante. En effet, ça s’appelle les commentaires. De plus, j’en parle ici parce qu’on va en avoir besoin et vous verrez que c’est très utilisé.

Bien utilisés, ils améliorent la lisibilité et la qualité de votre code, tout en facilitant la maintenance future.

Qu’est-ce qu’un commentaire et comment l’écrire ? :

En Python, un commentaire commence par le symbole #. Tout ce qui suit ce symbole sur la même ligne est ignoré par l’interpréteur.

Exemple simple :

Dans cet exemple, la ligne avec le dièse ne s’exécute pas, mais sert à expliquer ce que fait la ligne de code suivante.

Les commentaires sur plusieurs lignes :

Python permet aussi de créer des commentaires sur plusieurs lignes à l’aide de trois guillemets (""" """ ou ''' '''). Cela est utile pour documenter des programmes plus complexes.

Exemple :

Tout ce qui se trouve entre les trois guillemets est ignoré par Python. Cela permet d’ajouter des notes détaillées, sans supprimer le code.

Commentaires dans les éditeurs de code :

La plupart des éditeurs modernes comme Visual Studio Code ou Pixium permettent de commenter plusieurs lignes à la fois :

• Sélectionnez les lignes à commenter.
• Allez dans le menu Édition → Line Comment ou utilisez le raccourci clavier.
• Python ajoutera automatiquement le symbole # devant chaque ligne sélectionnée.

Exemple :

Ces fonctionnalités rendent l’ajout de commentaires rapide et efficace.

Pourquoi les commentaires sont-ils importants ?

• Clarté : ils expliquent le fonctionnement du code.
• Maintenance : ils aident à retrouver rapidement des parties importantes.
• Travail en équipe : ils permettent aux autres développeurs de comprendre vos intentions.

Les commentaires sont un outil indispensable pour écrire un code propre, lisible et facile à maintenir. Que ce soit pour une seule ligne ou plusieurs lignes, Python offre des solutions simples et efficaces pour documenter votre travail.

Exemple 1 : Commentaire sur une seule ligne

Affiche un message de bienvenue à l’utilisateur

Explication : Le dièse # indique que la ligne est un commentaire. Python ignore cette ligne lors de l’exécution. Utile pour expliquer ce que fait le code.

Exemple 2 : Commentaire sur plusieurs lignes

Explication : Les triples guillemets """ """ permettent de créer un bloc de commentaires sur plusieurs lignes. Idéal pour documenter un programme entier.

Exemple 3 : Commenter temporairement du code

Explication : On peut commenter des lignes que l’on ne souhaite pas exécuter pour le moment. Cela permet de tester le code ou de garder des notes pour plus tard.

Introduction aux variables et à la saisie utilisateur en Python