Commentaires Python
- 3813
- 136
- Romain Martinez
Introduction
Ce guide ne concerne pas la programmation. En fait, il n'y a pas du tout de nouveau code. Cependant, cela a tout à voir avec les assurer que le code que vous écrivez est compréhensible pour vous-même et toute autre personne qui pourrait le regarder sur la ligne.
Si vous avez examiné des projets open source, vous avez probablement remarqué des notes placées par les programmeurs. Ces notes sont tout simplement du texte. Le langage de programmation ne les compile ni ne les interprète de quelque manière que ce soit. Ça les ignore. Il sait que ces commentaires sont pour les humains, pas sur les ordinateurs.
Les commentaires sont très importants. Même si vous ne partagez pas votre code avec quelqu'un d'autre, vous rencontrerez un cas où vous regardez quelque chose que vous avez écrit il y a longtemps et vous vous demandez: «Qu'est-ce que j'ai fait ici?"Si vous êtes intéressé à travailler sur un projet open source, ce qui, c'est que vous êtes, puisque vous lisez ceci sur un site Web de Linux, le commentaire est encore plus important. La dernière chose que vous voulez, c'est que votre engagement soit rejeté parce qu'il n'est pas commenté et le mainteneur ne veut pas perdre de temps à comprendre ce qu'il fait. Les commentaires sont également importants dans les scripts système. Il y a très peu de départements informatiques pour personne, et vos collègues ne seront pas heureux s'ils ne savent pas ce qui se passe dans vos scripts.
Commentant dans Python
Comme beaucoup d'autres langues, Python a deux types de commentaires différents, célibataire et multiplié. Les commentaires à ligne unique sont excellents pour ajouter un commentaire rapide avant un bloc de code ou juste après une ligne de code expliquant ce qu'il fait. Les commentaires en plusieurs lignes sont utiles pour ajouter un en-tête ou une description plus détaillée à un morceau de code. Ils sont également parfaits pour commenter un bloc de code afin qu'il ne fonctionne pas, ce qui est idéal pour le débogage.
Commentaires de ligne unique
Dans Python, un commentaire à une seule ligne commence par un #. Ceci est un symbole assez courant à utiliser dans les langues de script. Voici un exemple de la façon dont vous utiliseriez un commentaire unique comme description.
a = 10 b = 15 a = b # définir un égal à B imprimer (A + B)
Le code fonctionnera exactement comme si le commentaire n'était pas là. Le commentaire est juste là pour vous.
Vous pouvez également utiliser un commentaire unique pour dire ce que les prochaines lignes de code feront.
# Importer la bibliothèque mathématique import Math # Exécutez le théorème de Pythagore a = 3 b = 4 c = mathématiques.sqrt (a ** 2 + b ** 2)
Même si c'est un exemple simple que vous pourriez probablement comprendre en le regardant, les commentaires le rendent beaucoup plus rapidement. Imaginez le temps qui serait sauvé sur un projet plus complexe.
Maintenant, jetez un œil à la façon dont vous pouvez utiliser un commentaire de ligne unique pour empêcher une ligne de code de l'exécution.
A = 10 B = 15 # A = B Que se passe-t-il si A n'est pas égal à B Print (A + B)
La ligne qui définit un égal à b n'a pas fonctionné, donnant un résultat différent de l'exemple précédent
Commentaires multi-lignes
Dans Python, vous pouvez désigner un commentaire multi-lignes en utilisant "" " avant et après le code que vous souhaitez commenter. Bien sûr, vous pouvez également l'utiliser pour des commentaires de texte plus longs comme les informations d'en-tête.
"" "Python Test Auteur = Votre nom Dernière mise à jour = 1 novembre 2016 Version Python - 3.4.3 Numéro de version = 1.0.0 "" "
Rien de tout cela ne signifie rien pour un ordinateur, mais il est excellent pour documenter les progrès d'un projet. Garder des informations comme celle-ci dans les fichiers du projet n'a pas d'impact sur le programme réel, mais il vous permet à vous et à toute autre personne travaillant sur le projet d'avoir un accès rapide et facile à des informations vitales. C'est idéal pour documenter des projets collaboratifs avec plusieurs fichiers et plusieurs auteurs. N'oubliez pas que la plupart des projets du monde réel seront complexes, donc documenter votre code de cette façon est une bonne habitude pour entrer dans.
Les commentaires multi-lignes sont également essentiels pour le débogage. Dites que vous venez d'implémenter une nouvelle fonctionnalité à votre projet, mais ce nouveau code provoque une erreur. Vous pouvez en commenter des sections entières pour tester la fonctionnalité de la nouvelle fonctionnalité, jusqu'à ce que vous découvriez enfin où se trouve le problème. Disons que l'exemple du «théorème de Pythagore» d'en haut faisait partie d'une fonctionnalité qui échouait. Vous pouvez faire quelque chose comme le code ci-dessous.
# Importer la bibliothèque mathématique Import Math "" "Échec - Veuillez déboguer # Exécutez le théorème Pythagorean A = 3 B = 4 C = SQRT (A ** 2 + B ** 2)" ""
Vous pouvez également utiliser des commentaires multi-lignes pour arrêter un ancien morceau de code pendant que vous le remplacez. Le simple fait de supprimer du code n'est généralement pas la meilleure pratique. Après tout, une fois que vous l'avez supprimé, c'est parti. Commentant que le code l'empêche de courir, mais le préserve également comme une référence ou un retour au cas où vous auriez besoin de le revoir.
Conclusion
Le code de commentaire est important. Qui ne peut pas être surestimé. Cela peut sembler fastidieux et ennuyeux. Il n'a pas le flash de l'écriture d'une nouvelle ligne de tueur qui implémente une fonctionnalité, mais à long terme, vous allez être heureux que ces commentaires soient là. Les commentaires sont également un outil de débogage inestimable qui peut vous fournir une procédure solide pour tester un code de code défaillant. Continuez à pratiquer l'utilisation des commentaires et à voir comment ils peuvent avoir un impact sur le flux de code lors de l'élimination des lignes ou des blocs de code.
Table des matières
- Guide d'introduction et d'installation de Python
- Fichiers Python et interprète
- Expérimenter des nombres et du texte en python
- Variables python
- Travailler avec des variables de nombre dans Python
- Python String Basics
- Chaînes de python avancées
- Commentaires Python
- Listes de python
- Méthodes de liste Python
- Listes multidimensionnelles python
- Tuples python
- Opérateurs booléens python
- Python If Instatations
- Python pendant les boucles
- Python pour les boucles
- Dictionnaires python
- Dictionnaires avancés Python
- Fonctions Python
Tutoriels Linux connexes:
- Python Expressions régulières avec des exemples
- Installez Arch Linux dans VMware Workstation
- Comment travailler avec l'API WooCommerce REST avec Python
- Comment créer une application Tkinter à l'aide d'un objet orienté…
- Comment gérer les référentiels Git avec Python
- Tutoriel de débogage GDB pour les débutants
- Advanced Bash Regex avec des exemples
- Choses à installer sur Ubuntu 20.04
- Boucles de bash avec des exemples
- Système linux hung? Comment s'échapper vers la ligne de commande et…