1.1.5 - Σχόλια

Μερικές φορές ο κώδικας χρειάζεται κάποια επιπλέον εξήγηση για το άτομο που το διαβάζει. Για να γίνει αυτό, προσθέτουμε σχόλια στον κώδικα. Τα σχόλια προορίζονται για την ανθρώπινη ανάγνωση του κώδικα και όχι για τον υπολογιστή.

Υπάρχουν δύο τρόποι για να δημιουργήσετε ένα σχόλιο . Το πρώτο είναι να χρησιμοποιήσετε το σύμβολο #. Ο υπολογιστής θα αγνοήσει οποιοδήποτε κείμενο σε ένα πρόγραμμα Python που εμφανίζεται μετά το #. Για παράδειγμα:

>>> # This is a comment, it begins with a # sign

>>> # and the computer will ignore it.

>>> print("This is not a comment, the computer will")

>>> print("run this and print it out.")

Εάν ένα πρόγραμμα έχει το σύμβολο # μεταξύ εισαγωγικών, δεν αντιμετωπίζεται ως σχόλιο . Ένας προγραμματιστής μπορεί να απενεργοποιήσει μια γραμμή κώδικα τοποθετώντας ένα σύμβολο # μπροστά της. Είναι επίσης δυνατό να υποβάλετε ένα σχόλιο στο τέλος μιας γραμμής.

>>> print("A # sign between quotes is not a comment.")

>>> # print("This is a comment, even if it is computer code.")

>>> print("Hi") # This is an end-of-line comment

Είναι δυνατόν να σχολιάσετε πολλές γραμμές κώδικα χρησιμοποιώντας τρία μονά εισαγωγικά στη σειρά για να οριοθετήσετε τα σχόλια.

'''

This is
a
multi
line
comment. Nothing
Will run in between these quotes.
print("There")

'''


Οι περισσότεροι επαγγελματίες προγραμματιστές της Python χρησιμοποιούν μόνο αυτόν τον τύπο σχολιασμού πολλαπλών γραμμών, κάτι που ονομάζεται docstrings . Τα docstrings επιτρέπουν την εγγραφή της τεκμηρίωσης μαζί με τον κώδικα και αργότερα αυτόματα εξαγωγή σε έντυπη τεκμηρίωση, ιστότοπους και ολοκληρωμένα αναπτυξιακά περιβάλλοντα (IDE). Για γενικά σχόλια , η ετικέτα # λειτουργεί καλύτερα.

Ακόμη και αν πρόκειται να είστε ο μόνος που διαβάζει τον κώδικα που γράφετε, τα σχόλια μπορούν να σας βοηθήσουν να εξοικονομήσετε χρόνο. Προσθέτοντας ένα σχόλιο που λέει "Handle alien bombs" θα σας επιτρέψει να θυμάστε γρήγορα τι κάνει αυτό το τμήμα του κώδικα χωρίς να χρειάζεται να το διαβάσετε και να το αποκρυπτογραφήσετε.