Εφόσον γνωρίζουμε ήδη πώς να γράφουμε τα σχόλια πολλών γραμμών, μπορούμε να χρησιμοποιήσουμε είτε τα τριπλά μονά εισαγωγικά είτε τα τριπλά διπλά εισαγωγικά. Χρησιμοποιούμε μια συμβολοσειρά τεκμηρίωσης όταν θέλουμε να περιγράψουμε τις λειτουργίες μας, ώστε να μπορούμε να λάβουμε την τεκμηρίωση όταν τη χρειαστούμε. Ορισμένα IDE σάς παρέχουν τεκμηρίωση τοποθετώντας τον δείκτη του ποντικιού πάνω από το όνομα και μερικά επισημαίνουν ορισμένες λέξεις-κλειδιά. Αλλά το γεγονός είναι ότι οι συμβολοσειρές εγγράφων στο NumPy είναι πολύ πιο ευέλικτες από ό,τι σε άλλες γλώσσες. Το Docstring είναι μια κυριολεκτική συμβολοσειρά που εμφανίζεται στην αρχή του ορισμού της συνάρτησης. Πρέπει να παρέχουμε συγκεκριμένες τιμές ενώ χρησιμοποιούμε τις συμβολοσειρές εγγράφων σε περιπτώσεις συναρτήσεων, κλάσεων κ.λπ.
Όταν χρησιμοποιούμε συμβολοσειρές εγγράφων με συναρτήσεις, πρέπει να περάσουμε τα ορίσματα. Όταν τα χρησιμοποιούμε με κλάσεις, περνάμε τα χαρακτηριστικά και τις μεθόδους. Στην περίπτωση των Ενοτήτων, πρέπει να παρέχουμε μια λίστα κλάσεων και συναρτήσεων. Στην περίπτωση του πακέτου περνάμε τη λίστα με τα modules με λειτουργικότητα. Οπότε, βασικά, ο σκοπός του docstring είναι, όπως εξηγεί το όνομα, ότι βοηθά στην τεκμηρίωση του κώδικά μας. Κάνουμε τεκμηρίωση ώστε αν κάποιος χρησιμοποιήσει τον κώδικά μας στο μέλλον, να μπορεί να κατανοήσει τον κώδικά μας και τη λογική πίσω από τον κώδικά μας με τη βοήθεια του docstring. Οι ενσωματωμένες λειτουργίες έχουν επίσης συμβολοσειρές εγγράφων. μπορούμε να χρησιμοποιήσουμε τη συνάρτηση help() για να δούμε τη συμβολοσειρά εγγράφων των ενσωματωμένων συναρτήσεων.
Υπάρχουν μερικές διαφορές μεταξύ σχολίων και συμβολοσειρών εγγράφων. Τα σχόλια αγνοούνται από τους διερμηνείς, αλλά οι συμβολοσειρές εγγράφων δεν αγνοούνται από τους διερμηνείς. Η μνήμη εκχωρείται σε συμβολοσειρές εγγράφων. Ένα σχόλιο είναι μια περιγραφή του κώδικα, αλλά από την άλλη πλευρά, οι συμβολοσειρές εγγράφων μας λένε τον σκοπό του κώδικα.
Σύνταξη:
Η σύνταξη για την εγγραφή των εγγράφων στο NumPy είναι:
'''Μήνυμα εγγράφων'''
Ή
'''Μήνυμα εγγράφων''
Λάβετε υπόψη ότι το docstring δεν είναι συνάρτηση ή μέθοδος, επομένως δεν έχει σωστή σύνταξη. Το μόνο πράγμα που πρέπει να σημειώσουμε εδώ είναι ότι ξεκινάμε το docstring με τρία μονά εισαγωγικά ή τρία διπλά εισαγωγικά. Γράφουμε την περιγραφή του κώδικα και τον τελειώνουμε ξανά με τρία μονά εισαγωγικά ή τρία διπλά εισαγωγικά στο τέλος. Δεν υπάρχει κάτι υποχρεωτικό να γράψετε για τα docstrings. Απλώς πρέπει να βάλετε τρία μονά ή διπλά εισαγωγικά πριν και μετά την περιγραφή της συμβολοσειράς σας.
Παράδειγμα 1:
Για να κατανοήσουμε καλύτερα τις συμβολοσειρές εγγράφων, ας εκτελέσουμε ένα παράδειγμα. Σε αυτό το παράδειγμα, αφού συμπεριλάβουμε τη βιβλιοθήκη NumPy, δηλώνουμε απλώς τη μεταβλητή 'a' και μια άλλη μεταβλητή 'b'. Μετά από αυτό, δημιουργούμε τη συμβολοσειρά μας που λέει 'Ας προσθέσουμε μεταβλητές 'a' και 'b'. Στην περίπτωσή μας, αυτό είναι ένα εύκολο παράδειγμα, αλλά αν ο κώδικάς μας είναι πολύπλοκος, αυτό βοηθάει πολύ τον κωδικοποιητή στην κατανόηση του κώδικα. Μετά από αυτό, αθροίζουμε τις μεταβλητές 'a' και 'b' και αποθηκεύουμε το αποτέλεσμα εξόδου τους σε μια άλλη μεταβλητή που είναι 'c'. Τέλος, εκτυπώνουμε την τιμή της μεταβλητής “c”. Τώρα, εκτελούμε τον κώδικα μας.
εισαγωγή μουδιασμένος όπως και π.χ.ένα = 1
σι = δύο
'''Ας προσθέσουμε μεταβλητές a και b''
ντο = α+β
Τυπώνω ( ντο )
Αυτό είναι το αποτέλεσμα μας από το συγκεκριμένο κομμάτι κώδικα. Μπορούμε να δούμε ότι το σύστημα δεν έχει δώσει κανένα σφάλμα σχετικά με λανθασμένη σύνταξη ή τίποτα για τη γραμμή 7 του κώδικά μας. Επίσης, το σύστημα δεν έχει εκτυπώσει τη συμβολοσειρά μας. Αντίθετα, εκτύπωσε μόνο την έξοδο της μεταβλητής μας 'c' στην οποία είπαμε στο σύστημά μας να εκτυπώσει. Αυτό δείχνει πώς λειτουργούν τα docstrings. Την επόμενη φορά, όταν ένας νέος κωδικοποιητής προσπαθήσει να εργαστεί στον κώδικά μας, θα καταλάβει τι κάνουμε με τη βοήθεια της συμβολοσειράς μας. Αλλά δεν θα εκτυπωθεί ως έξοδος, ώστε ο χρήστης του κώδικα να μην ενοχλείται από αυτό.
Παράδειγμα 2:
Τώρα, εκτελούμε ένα σύνθετο παράδειγμα για να κατανοήσουμε τη λειτουργία της συμβολοσειράς εγγράφων. Αρχικά, συμπεριλαμβάνουμε τη βιβλιοθήκη NumPy και στη συνέχεια γράφουμε μια συμβολοσειρά εγγράφου στην οποία εξηγούμε την επόμενη γραμμή κώδικα όπου εξηγούμε την προετοιμασία του πίνακα. Προσθέτουμε επίσης τις συμβολοσειρές εγγράφων στο άλλο μέρος του κώδικα. Τώρα, αν μοιραστούμε αυτόν τον κώδικα με οποιονδήποτε νέο προγραμματιστή Python χωρίς να προσθέσουμε τις συμβολοσειρές εγγράφων, θα είναι κατά κάποιο τρόπο δύσκολο γι 'αυτόν να γνωρίζει τη λειτουργία και το σκοπό αυτού του κώδικα. Πρέπει πρώτα να ψάξει για τις λειτουργίες που χρησιμοποιήσαμε. Αλλά αν προσθέσουμε μια συμβολοσειρά εγγράφων στον κώδικά μας, θα είναι εύκολο για τους άλλους προγραμματιστές να κατανοήσουν τον κώδικα χωρίς να μελετήσουν περισσότερα για τις λειτουργίες. Δεν περιοριζόμαστε στην προσθήκη σχολίων σε ορισμένα όρια. Τα σχόλια μπορεί να είναι μίας ή περισσότερων από μία γραμμών. Μπορεί επίσης να προστεθεί περισσότερες από μία φορές σε έναν κωδικό. Στη συνέχεια, εισαγάγετε το NumPy ως np.
'''Δημιουργία της μεταβλητής στην οποία θα περάσουμε έναν πίνακα μεγέθους 1x6'''πίνακας = π.χ. πίνακας ( [ έντεκα , 22 , 33 , 44 , 55 , 66 ] )
'''αντιστοιχίζοντας τον πίνακα στη συνάρτηση tofile() για να τον αφήσουμε να αποθηκευτεί στο αρχείο με το όνομα arr'''
πίνακας . να αρχειοθετήσω ( 'arr.bin' )
'''εμφάνιση του αρχείου χρησιμοποιώντας τη λειτουργία fromfile''
Τυπώνω ( π.χ. από αρχείο ( 'arr.bin' , dtype = ενθ ) )
Όπως φαίνεται στο παρακάτω απόσπασμα, οι συμβολοσειρές εγγράφων δεν εμφανίζονται στην έξοδο, πράγμα που σημαίνει ότι δεν επηρεάζει την έξοδο ή τη μεταγλώττιση του κώδικα. Οι συμβολοσειρές εγγράφων αγνοούνται κατά τη διαδικασία μεταγλώττισης.
συμπέρασμα
Σε αυτόν τον οδηγό, μάθαμε για τις συμβολοσειρές εγγράφων στο NumPy. Συγκρίναμε τα docstrings με σχόλια και εξηγήσαμε τη διαφορά μεταξύ τους. Μάθαμε τη σύνταξη των docstrings και πώς να γράφουμε τα docstrings στον κώδικά μας. Επιπλέον, προσπαθήσαμε επίσης να εξηγήσουμε τι είναι οι συμβολοσειρές εγγράφων στο NumPy και πώς λειτουργούν με τη βοήθεια παραδειγμάτων. Τέλος, παρατηρήσαμε ότι είναι απαραίτητα για τους κωδικοποιητές. Δεν θα επαναλάβουμε τη σημασία των εγγράφων στο NumPy. Θα πούμε απλώς ότι πρέπει να χρησιμοποιήσετε τις συμβολοσειρές εγγράφων στον κώδικά σας. Στο NumPy, το στυλ γραφής των εγγράφων είναι το πιο δημοφιλές. Χρησιμοποιείται ευρέως στην κοινότητα προγραμματισμού για να ενημερώνει ο ένας τον άλλον σχετικά με τη λειτουργία και τη λειτουργικότητα των κωδικών τους. Αυτός ο οδηγός θα σας βοηθήσει να ξεκινήσετε με τις συμβολοσειρές εγγράφων NumPy. Προσπαθήσαμε να καλύψουμε τα περισσότερα από αυτά που θα χρειαστείτε χρησιμοποιώντας τις συμβολοσειρές εγγράφων στο NumPy.