Σε αυτό το σεμινάριο, θα μάθουμε να δημιουργούμε σχόλια στο Python με τη βοήθεια παραδειγμάτων.
Βίντεο: Σχόλια στο Python
Τα σχόλια είναι περιγραφές που βοηθούν τους προγραμματιστές να κατανοήσουν καλύτερα την πρόθεση και τη λειτουργικότητα του προγράμματος.
Αγνοούνται πλήρως από τον διερμηνέα Python
Πλεονεκτήματα της χρήσης σχολίων
Η χρήση σχολίων σε προγράμματα καθιστά τον κώδικα πιο κατανοητό. Κάνει το πρόγραμμα πιο ευανάγνωστο, το οποίο μας βοηθά να θυμόμαστε γιατί γράφτηκαν ορισμένα τμήματα κώδικα.
Εκτός από αυτό, τα σχόλια μπορούν επίσης να χρησιμοποιηθούν για την παράβλεψη κάποιου κώδικα κατά τη δοκιμή άλλων μπλοκ κώδικα. Αυτό προσφέρει έναν απλό τρόπο για να αποτρέψετε την εκτέλεση ορισμένων γραμμών ή να γράψετε έναν γρήγορο ψευδοκώδικα για το πρόγραμμα.
Σχόλια μιας γραμμής στο Python
Στο Python, χρησιμοποιούμε το σύμβολο κατακερματισμού #για να γράψουμε ένα σχόλιο μίας γραμμής.
Παράδειγμα 1: Σύνταξη σχολίων μίας γραμμής
# printing a string print('Hello world')
Παραγωγή
Γειά σου Κόσμε
Εδώ, το σχόλιο είναι:
# printing a string
Αυτή η γραμμή αγνοείται από τον διερμηνέα Python.
Όλα όσα ακολουθούν #αγνοούνται. Έτσι, μπορούμε επίσης να γράψουμε το παραπάνω πρόγραμμα σε μία γραμμή ως:
print('Hello world') #printing a string
Η έξοδος αυτού του προγράμματος θα είναι η ίδια όπως στο Παράδειγμα 1 . Ο διερμηνέας αγνοεί όλο το κείμενο μετά #.
Σχόλια πολλαπλών γραμμών στο Python
Η Python δεν προσφέρει έναν ξεχωριστό τρόπο για να γράψετε σχόλια πολλαπλών γραμμών. Ωστόσο, υπάρχουν και άλλοι τρόποι αντιμετώπισης αυτού του ζητήματος.
Μπορούμε να χρησιμοποιήσουμε #στην αρχή κάθε γραμμής σχολίων σε πολλές γραμμές.
Παράδειγμα 2: Χρήση πολλαπλών #
# it is a # multiline # comment
Εδώ, κάθε γραμμή αντιμετωπίζεται ως ένα μόνο σχόλιο και όλα αυτά αγνοούνται.
String Literals για σχόλια πολλαπλών γραμμών
Παρόλο που δεν υπάρχει μοναδικός τρόπος για να γράψετε σχόλια πολλαπλών γραμμών στο Python, γνωρίζουμε ότι ο διερμηνέας Python αγνοεί τα γράμματα των συμβολοσειρών που δεν έχουν αντιστοιχιστεί σε μια μεταβλητή.
Έτσι, μπορούμε ακόμη να γράψουμε ένα σχόλιο μίας γραμμής ως:
#this is a comment 'this is an unassigned string as a comment '
Εδώ, μπορούμε να δούμε ότι η δεύτερη γραμμή του προγράμματος είναι μια συμβολοσειρά αλλά δεν έχει αντιστοιχιστεί σε καμία μεταβλητή ή συνάρτηση. Έτσι, ο διερμηνέας αγνοεί τη συμβολοσειρά.
Με παρόμοιο τρόπο, μπορούμε να χρησιμοποιήσουμε χορδές πολλαπλών γραμμών (τριπλά εισαγωγικά) για να γράψουμε σχόλια πολλαπλών γραμμών.
Ο χαρακτήρας των εισαγωγικών μπορεί να είναι 'είτε ".
Παράδειγμα 3: Χρήση String Literals για τη σύνταξη σχολίων πολλαπλών γραμμών
''' I am a multiline comment! ''' print("Hello World")
Εδώ, η συμβολοσειρά πολλαπλών γραμμών δεν έχει εκχωρηθεί σε καμία μεταβλητή, επομένως αγνοείται από τον διερμηνέα. Παρόλο που δεν είναι τεχνικά ένα πολύπλευρο σχόλιο, μπορεί να χρησιμοποιηθεί ως ένα.
Pstron docstrings
Κατά κανόνα, τα τριπλά εισαγωγικά που εμφανίζονται αμέσως μετά τη συνάρτηση, τη μέθοδο ή τον ορισμό κλάσης είναι docstrings (συμβολοσειρές τεκμηρίωσης).
Τα έγγραφα συσχετίζονται με αντικείμενα και είναι προσβάσιμα μέσω του __doc__χαρακτηριστικού.
Για να μάθετε περισσότερα, επισκεφτείτε το Python docstrings.
Πώς να γράψετε καλύτερα σχόλια;
- Χρησιμοποιήστε σχόλια για να περιγράψετε τι κάνει μια συνάρτηση και όχι τις συγκεκριμένες λεπτομέρειες σχετικά με τον τρόπο που η συνάρτηση την κάνει.
- Προσπαθήστε να καταργήσετε όσο το δυνατόν περισσότερα περιττά σχόλια. Δοκιμάστε να γράψετε κώδικα που μπορεί να εξηγηθεί, χρησιμοποιώντας καλύτερη επιλογή ονόματος / μεταβλητής.
- Προσπαθήστε να κάνετε τα σχόλια όσο το δυνατόν πιο σύντομα και συνοπτικά.
