commentaire Python

Un commentaire Python est une ligne de texte dans un programme qui n’est pas exécuté par l’interpréteur. Les commentaires sont utilisés pendant le débogage pour identifier les problèmes et expliquer le code. Les commentaires commencent par un caractère dièse (#).

Les commentaires indiquent des notes ou du code que vous ne voulez pas que Python exécute. Par exemple, disons que vous écrivez une procédure complexe sur une période de plusieurs heures. Vous voudrez peut-être écrire quelques commentaires pour garder une trace de ce que fait chaque ligne de code afin de ne pas perdre de vue.

√âcrire des commentaires est utile pour un certain nombre de raisons. Si vous travaillez avec un gros programme Python, les commentaires peuvent vous aider à garder une trace de ce qui se passe. Les commentaires aident également les membres de l’équipe à s’assurer que tout le monde comprend le travail de chacun sur un projet collaboratif.

Chaque développeur se retrouve finalement dans une situation o√π il doit inclure des commentaires lors de l’écriture du code.

Mais comment faire vous commentez du code en Python ? Comme tout autre langage de programmation, Python prend en charge les commentaires. Dans ce guide, nous allons parler de la rédaction de commentaires en Python.

Qu’est-ce qu’un commentaire Python ?

Un commentaire Python est une ligne de texte qui apparaaît dans un programme mais n’est pas exécuté par le programme. Vous pouvez déclarer un commentaire à l’aide d’un hashtag (#). Les commentaires peuvent apparaaître sur une nouvelle ligne ou à la fin d’une ligne de code existante.

Les commentaires sont utilisés pour expliquer le fonctionnement du code et à des fins de test.

Voici un exemple un commentaire d’une seule ligne en Python :

81 % des participants ont déclaré qu’ils se sentaient plus confiants quant à leurs perspectives d’emploi en technologie après avoir assisté à un bootcamp. Soyez jumelé à un bootcamp aujourd’hui.

Le diplômé moyen d’un bootcamp a passé moins de six mois en transition de carrière, du démarrage d’un bootcamp à la recherche de son premier emploi.

Vous pouvez voir le dièse # marque indique notre commentaire. Nous avons séparé notre texte de commentaire et le signe # par un espace. Ce n’est pas nécessaire mais cela rend chaque commentaire plus facile à lire.

Cette ligne est ignorée par le compilateur lorsque nous exécutons notre code. Les commentaires doivent être lus par des humains. Ils ne sont pas destinés à être exécutés par un programme.

Les commentaires doivent être ajoutés au même niveau de retrait que le code auquel le commentaire fait référence. Par exemple, disons que vous écrivez à propos d’une ligne de code dans une instruction if. Vous indenteriez votre commentaire de la même manière que vous l’avez fait avec votre code.

Exemple de commentaires Python

Disons que vous écrivez une boucle for et que vous voulez vous rappeler comment cela fonctionne. Vous pouvez écrire un quelques commentaires. Lorsque vous reviendrez regarder votre code plus tard, vous pourrez lire vos notes.

Dans une boucle Python for , vous pouvez avoir des commentaires qui ressemblent à ceci :

Nos commentaires nous aident à comprendre le but de notre code et à garder une trace de ce qui se passe.

Utilisons un exemple pour illustrer la structure d’indentation e de commentaires en Python. Dans l’exemple ci-dessous, notre programme parcourt deux tableaux Python et attribue à chaque étudiant un réussite ou un échec pour leur test. Les réussites et les échecs sont déterminés en fonction des étudiants‚Äô score numérique sur leur test :

Ce programme prend une liste d’étudiants et leurs notes. Ensuite, notre programme parcourt la liste des étudiants. Nous vérifions si chaque élève a réussi ou échoué son test.

Dans l’exemple ci-dessus, vous pouvez voir que nous commentons sur le même niveau d’indentation que la ligne à laquelle nous nous référons. Lorsque nous discutons de notre instruction Python if, par exemple, nous avons mis en retrait notre commentaire ainsi que notre code.

En écrivant ces commentaires d’une seule ligne, notre programme est plus lisible à la fois pour l’auteur du code. Notre programme est également plus facile pour toute autre personne qui peut regardez notre programme pour lire.

Commentaires Python Inline

Les commentaires Python Inline sont écrits sur la même ligne qu’une instruction, après que le code a été écrit. Les commentaires inline doivent expliquer le but d’une ligne de code ou comment cela fonctionne.

Voici la syntaxe pour un commentaire en ligne :

Les commentaires en ligne sont utiles si vous devez expliquer des parties compliquées du code. Ils sont également utiles si vous pensez que vous pouvez oublier comment une ligne de code spécifique fonctionne à l’avenir.

Les commentaires en ligne sont également utiles si vous êtes travailler en équipe et vous devez vous assurer que tout le monde comprend une ligne spécifique.

Contrairement aux autres types de commentaires, n’utilisez les commentaires en ligne qu’occasionnellement. En effet, trop de commentaires en ligne rendent un programme difficile à lire.

Commentaires Python multilignes

Les commentaires Python multilignes, ou les commentaires de bloc Python, expliquent le code qui est soit plus compliqué, soit dont le but n’est pas immédiatement évident. Vous pouvez utiliser un commentaire de bloc pour expliquer une fonction unique qui utilise une bibliothèque externe, par exemple.

Les commentaires de bloc sont des commentaires multilignes en Python et s’appliquent à tout ou partie du code en dessous d’eux. Les commentaires en bloc, comme tout autre commentaire, sont également indentés au même niveau que le code dont parle le commentaire.

Exemple de commentaire multiligne

Voici un exemple de chaaîne multiligne qui explique une fonction Python sort() :

"Career Karma est entré dans ma vie au moment o√π j’en avais le plus besoin et m’a rapidement aidé à suivre un bootcamp. Deux mois après avoir obtenu mon diplôme, j’ai trouvé l’emploi de mes rêves qui correspondait à mes valeurs et à mes objectifs dans la vie !"

Venus, ingénieur logiciel chez Rockbot

Notre commentaire s’étend sur plusieurs lignes et décrit le but du code écrit en dessous.

Alors que certains développeurs peuvent comprendre ce code, d’autres programmeurs peuvent être confus quant à son fonctionnement ou pourquoi il a été écrit. L’utilisation d’un commentaire de bloc est un excellent moyen d’expliquer une procédure entière. Les commentaires de bloc sont utiles pour expliquer tout autre code dont le but n’est pas immédiatement évident pour un développeur.

Conclusion

C’est ainsi que vous commentez en Python ! Utilisation des commentaires , vous pouvez rendre vos programmes plus lisibles pour tout le monde, y compris vous-même.

Des commentaires bien rédigés peuvent vous aider à garder une trace de votre code au fur et à mesure. Ils vous permettent de conserver un enregistrement qui peut être consulté revenir plus tard si vous avez du mal à comprendre votre code plus tard.

√ätes-vous prêt à relever un défi ? √âcrivez un commentaire de bloc en haut de l’un de vos programmes. Ce commentaire doit inclure :

Essayez d’exécuter votre code. Si votre programme ne s’exécute pas à cause du commentaire, vous avez fait une erreur. Si votre programme fonctionne normalement, félicitations ! Vous avez écrit un commentaire avec succès.

Dans ce tutoriel, nous avons exploré comment écrire des commentaires, des commentaires en ligne et des commentaires de bloc en Python. Nous avons également discuté de la façon dont certains développeurs écrivent des commentaires pour les tests. Vous pouvez désormais écrire des commentaires comme un expert Python !

Vous cherchez à maaîtriser le langage de programmation Python ? Pour obtenir de l’aide sur les meilleurs cours, livres et ressources d’apprentissage Python, consultez notre guide complet sur l’apprentissage de Python.

Shop

Learn programming in R: courses

$

Best Python online courses for 2022

$

Best laptop for Fortnite

$

Best laptop for Excel

$

Best laptop for Solidworks

$

Best laptop for Roblox

$

Best computer for crypto mining

$

Best laptop for Sims 4

$

Latest questions

NUMPYNUMPY

psycopg2: insert multiple rows with one query

12 answers

NUMPYNUMPY

How to convert Nonetype to int or string?

12 answers

NUMPYNUMPY

How to specify multiple return types using type-hints

12 answers

NUMPYNUMPY

Javascript Error: IPython is not defined in JupyterLab

12 answers

News


Wiki

Python OpenCV | cv2.putText () method

numpy.arctan2 () in Python

Python | os.path.realpath () method

Python OpenCV | cv2.circle () method

Python OpenCV cv2.cvtColor () method

Python - Move item to the end of the list

time.perf_counter () function in Python

Check if one list is a subset of another in Python

Python os.path.join () method