Introduction aux commentaires en Python
Il est essentiel de comprendre le flux de programmation, ce que l'on code et pourquoi. Généralement, pour ce faire, un programmeur utilise des commentaires pour montrer à quoi sert ce morceau de code, quelle méthode est utilisée pour le codage / la logique derrière. Ces commentaires n'influenceront pas le code, mais ils fourniront une présentation de ce qui est fait. L'écriture de commentaires dans le code aide à améliorer le code comme dans l'optimisation, un programmeur vérifie ce qui devait être amélioré et si les commentaires montrent la méthode utilisée, il sera facile d'optimiser le programme. Les commentaires en Python permettent également aux autres développeurs de connaître et de comprendre le programme. Il est recommandé d'utiliser un nombre suffisant de commentaires afin que le code ne soit pas déroutant quand il a regardé en arrière.
Types de syntaxe en Python
En Python, il existe deux types de syntaxes utilisées pour les commentaires:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
Dans tous les langages de programmation, une syntaxe a été définie pour identifier ce qui est quoi. Un programme est défini avec un certain nombre de syntaxes pour, par exemple, la fermeture d'une ligne en c, nous utilisons un point-virgule ';', Pour définir le démarrage d'une classe ou d'une boucle, nous utilisons deux points ':'. Comme on peut le voir, nous avons une syntaxe différente qui fait partie du code et l'affecte. Il devrait y avoir une syntaxe qui pourrait dire complier pour laisser la partie commentée et passer à l'étape suivante, car les commentaires n'ont rien à voir avec la sortie. Ainsi, il est vraiment très nécessaire de distinguer les commentaires du code réel afin qu'il ne soit pas confondu avec le programme réel.
Création de commentaires en Python
Un programmeur doit ajouter un commentaire dans son programme pour le rendre plus compréhensible. Maintenant, où ajouter des commentaires? C'est le choix d'un individu, mais voici quelques endroits communs où l'ajout de commentaires rend un programme plus lisible.
- Début du programme
- Lors de la définition des paramètres
- Définir une classe
- Définition des méthodes
- Logique pour les méthodes / fonctions
- Description À propos de la procédure
- Pour recouper la sortie d'un morceau de code
Les points suivants ont été expliqués ci-dessous:
1. Début du programme
Ici, un programmeur définit quelle est l'énoncé du problème et quel est le besoin du programme.
2. Lors de la définition des paramètres
Ici, un programmeur peut ajouter des commentaires pour chaque paramètre ce qu'il représente, comment cela aidera dans le programme.
3. Définir une classe
Un programme peut contenir null / une ou plusieurs classes, il est donc essentiel de définir l'objectif de la classe au début des commentaires. Parfois, il est conseillé d'ajouter des commentaires entre les classes pour définir le travail de chaque ligne de la classe.
4. Définition des méthodes
Les méthodes sont des fonctions qui créent des relations entre les paramètres et une logique pour les manipuler. Il est recommandé de définir le travail de la méthode dans les commentaires.
5. La logique des méthodes / fonctions
En général, une méthode peut être associée à un certain nombre de logiques, la description des commentaires de chaque logique peut aider à comprendre la logique existante et, si nécessaire, peut être modifiée conformément aux exigences.
6. Description de la procédure
Pour chaque programme, un programmeur suit une procédure étape par étape et la définition des étapes de la procédure / Architecture du code dans les commentaires pourrait aider à améliorer sa lisibilité.
7. Pour recouper la sortie d'un morceau de code
Dans un certain nombre de cas, un programmeur devra apporter des modifications au programme existant. Si un programme a un certain nombre de logiques et pour vérifier si tout fonctionne bien ou non, il devrait avoir une sortie de référence / sortie attendue. Commenter les sorties de cette logique juste après la logique pourrait faire gagner beaucoup de temps.
Exemples de commentaires en Python
Les exemples sont donnés ci-dessous:
Les commentaires n'ont aucun effet sur la sortie, mais ils rendent le programme plus lisible. Voici quelques exemples de commentaires en python.
1. Commenter une ligne à la fois: Ici, nous effectuons une opération d'addition sur deux variables.
# Performing addition of two variables
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Sortie: 22
2. Commenter plusieurs lignes à la fois: Parfois, il est nécessaire de fournir une description d'une logique, pour laquelle il est nécessaire de commenter plusieurs lignes à la fois. Commenter une seule ligne, encore et encore, pourrait être un travail fatigant, nous utilisons donc des guillemets triples pour cela.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
"""
a = 12
b = 10
addition = a + b
print(addition)
Sortie: 22
3. Commenter une ligne ainsi que plusieurs lignes en même temps: Dans la plupart des cas, un programmeur utilise les deux types de commentaires pour rendre le programme plus lisible.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
“””
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Sortie: 22
Ici, nous avons vu quelques cas de commentaires, qui sont utilisés dans un programme. Dans le cas de l'apprentissage automatique, il existe différents types de modèles, qui sont utilisés pour prédire la sortie. Il faut modéliser les paramètres, les hyperparamètres et la procédure utilisée dans l'algorithme. Commenter différentes approches pour le modèle avec différents paramètres peut économiser la répétabilité et gagner du temps.
Conclusion - Commentaires en Python
Les commentaires dans un programme sont très utiles pour les comprendre. En python, nous avons essentiellement deux types de commentaires, soit pour commenter une ligne avec la syntaxe (#), soit pour commenter plusieurs lignes, nous utilisons des guillemets triples (“). Les commentaires ne sont pas là pour influencer le code mais simplement pour ajouter une description de ce qui y est codé et les commentaires ne feront pas partie de la sortie.
Articles recommandés
Ceci est un guide des commentaires en Python. Nous discutons ici de l'introduction, de la création de commentaires en Python, des exemples et de la syntaxe, etc. Vous pouvez également consulter nos autres articles suggérés pour en savoir plus -
- Échange en Python
- Commandes Python
- Ingénierie inverse avec Python
- Échange en C
- Variables en JavaScript
- Ingénierie inverse | Utilisations | Questions éthiques
- Comment les commentaires fonctionnent-ils en PHP? | Exemples