Σε αυτό το άρθρο, θα μάθετε για τα σχόλια Swift, γιατί και πώς να τα χρησιμοποιήσετε.
Ένα σχόλιο είναι μια επεξήγηση ή σχολιασμός με δυνατότητα ανάγνωσης από τον προγραμματιστή στον πηγαίο κώδικα ενός προγράμματος. Αγνοείται από τον μεταγλωττιστή κατά τη σύνταξη του κώδικα.
Τα σχόλια προορίζονται για άτομο που διαβάζει τον κώδικα για να κατανοήσει καλύτερα την πρόθεση και τη λειτουργικότητα του προγράμματος. Μπορεί να είναι χρήσιμο ενώ εργάζεστε σε μια ομάδα για να αποσαφηνίσετε τον σκοπό του κώδικα για άλλα μέλη της ομάδας ή ενώ εργάζεστε αποκλειστικά, μπορεί να λειτουργήσει ως υπενθύμιση για να αποκτήσετε.
Swift Σχόλιο και οι τύποι του
Ταχύτερα υπάρχουν δύο τύποι σχολίων:
1. Σχόλιο μίας γραμμής
Στο Swift, κάθε γραμμή που ξεκινά με δύο κάθετες //είναι ένα σχόλιο μίας γραμμής. Όλα που ξεκινούν με δύο κάθετες //αγνοούνται από τον μεταγλωττιστή.
Μπορείτε να βρείτε ένα απλό παράδειγμα στην κορυφή της παιδικής χαράς:
//: Παιδική χαρά - ουσιαστικό: ένα μέρος όπου οι άνθρωποι μπορούν να παίξουν
Ξεκινά με δύο κάθετες //και παρέχει ουσιαστική εξήγηση του αρχείου ως ": Playground - ουσιαστικό: ένα μέρος όπου οι άνθρωποι μπορούν να παίξουν".
Παράδειγμα 1: Σχόλιο μίας γραμμής
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Το παραπάνω παράδειγμα περιέχει δύο σχόλια μιας γραμμής:
// Δείγμα προγράμματος // αποθηκεύει 3,14 σε μεταβλητή pi
2. Πολυγραμμικό σχόλιο
Εάν το σχόλιό σας περιλαμβάνει πολλές γραμμές, μπορείτε να το επισυνάψετε μέσα /*… */.
Τα σχόλια πολλαπλών γραμμών ξεκινούν με μια μπροστινή κάθετο ακολουθούμενη από έναν αστερίσκο ( /*) και τελειώνουν με έναν αστερίσκο που ακολουθείται από μια μπροστινή κάθετο ( */). Όλα ενδιάμεσα /*και */αγνοούνται από τον γρήγορο μεταγλωττιστή.
/ * Αυτό είναι ένα πολύπλευρο σχόλιο. Αφού γράψετε ένα πολύπλευρο σχόλιο προσθέστε * ακολουθώντας από / για να το τερματίσετε
Παράδειγμα 2: Πολυγραμμικό σχόλιο
/* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)
Το παραπάνω παράδειγμα περιέχει ένα πολύπλευρο σχόλιο.
/ * Η τιμή pi με κωδικό μπορεί να είναι λιγότερο ακριβής. Έτσι μπορείτε να υπολογίσετε τη χρήση σε ενσωματωμένους τύπους δεδομένων για πιο ακριβή τιμή * /
Πράγματα που πρέπει να θυμάστε
Αν και τα σχόλια έχουν νόημα για την καλύτερη κατανόηση της πρόθεσης του γραμμένου κώδικα. Εδώ είναι πράγματα που πρέπει να λάβετε υπόψη κατά τη σύνταξη του:
- Μην περικλείετε σχόλια με // στο multiline αν και είναι έγκυρο και ο μεταγλωττιστής αγνοεί αυτές τις γραμμές. Αντίθετα, εσωκλείστε το σε ένα πολύπλευρο σχόλιο
/*… */
.// Αυτό είναι ένα σχόλιο. // Χρησιμοποιήστε το όταν είναι απαραίτητο και με ακρίβεια
Ο παραπάνω τρόπος για να γράψετε σχόλιο είναι σωστός αλλά δεν συνιστάται γιατί πρέπει να γράψετε πολλαπλά σχόλια εάν το σχόλιο είναι μεγαλύτερο από μία γραμμή. Ο καλύτερος τρόπος για να γράψετε είναι να χρησιμοποιήσετε ένα πολύπλευρο σχόλιο ως:/ * Αυτό είναι ένα σχόλιο. Χρησιμοποιήστε το όταν είναι απαραίτητο και με ακρίβεια * /
- Το σχόλιο μίας γραμμής μπορεί να γραφτεί σε ξεχωριστή γραμμή ή μαζί με κωδικό στην ίδια γραμμή. Ωστόσο, συνιστάται η χρήση σχολίων σε ξεχωριστή γραμμή.
Παράδειγμα:let pi = 3.14159 // αποθηκεύει το 3.14 στη μεταβλητή pi
Αυτός ο τρόπος για να γράψετε σχόλια είναι έγκυρος. Αλλά είναι καλύτερο να γράφετε σχόλια σε ξεχωριστή γραμμή ως:// αποθηκεύει 3,14 στη μεταβλητή pi let pi = 3.14159
- Ακόμα κι αν είστε μεμονωμένος προγραμματιστής σε μια ομάδα και είστε ο μόνος που γράφει τον κώδικα, εάν είναι ασυμπτωματικός, θα δυσκολευτείτε να προσπαθήσετε να καταλάβετε τον σκοπό του στο πρόγραμμα. Επομένως, χρησιμοποιήστε το με ακρίβεια και δώστε μια ουσιαστική περιγραφή.
- Κάντε το σχόλιο πολύ απλό και νόημα.
- Μην γράφετε περιττά σχόλια στον κωδικό σας.
- Στις περισσότερες περιπτώσεις, χρησιμοποιήστε σχόλια για να εξηγήσετε «γιατί» και όχι «πώς».
