Βελτιώστε την αναγνωσιμότητα και τη δυνατότητα συντήρησης του κώδικα JavaScript ακολουθώντας αυτές τις συμβάσεις ονομασίας.
Είναι απαραίτητο να διατηρήσετε την απλότητα, την αναγνωσιμότητα και την ευκολία συντήρησης στον κώδικά σας προκειμένου να διαχειριστείτε πολύπλοκα έργα JavaScript. Η συνεπής τήρηση των συμβάσεων ονομασίας είναι το κλειδί για την επίτευξη αυτού του στόχου.
Μεταβλητές, boolean, συναρτήσεις, σταθερές, κλάσεις, στοιχεία, μέθοδοι, ιδιωτικές συναρτήσεις, καθολικές μεταβλητές και αρχεία είναι μεταξύ των στοιχείων JavaScript που απαιτούν συνεπείς συμβάσεις ονομασίας. Μπορείτε να βελτιώσετε την οργάνωση και την κατανόηση κώδικα εφαρμόζοντας τυποποιημένες συμβάσεις ονομασίας σε όλα αυτά τα στοιχεία, εξοικονομώντας χρόνο και προσπάθεια μακροπρόθεσμα.
1. Ονομασία μεταβλητών
Στο JavaScript, τα δεδομένα αποθηκεύονται σε μεταβλητές. Είναι σημαντικό να επιλέγετε περιγραφικά ονόματα για μεταβλητές που αντικατοπτρίζουν με ακρίβεια τη λειτουργία τους. Θα μπορούσατε, για παράδειγμα, να αντικαταστήσετε όνομα χρήστη ή συνολικό ποσό για το όνομα μιας μεταβλητής παρά Χ.
Ένας καλός τρόπος για να ονομάσετε μεταβλητές είναι ο εξής:
αφήνω συνολικήΤιμή = 100;
αφήνω Όνομα χρήστη = "Γιάννης";Η βελτιωμένη αναγνωσιμότητα κώδικα μπορεί να επιτευχθεί χρησιμοποιώντας περιγραφικά ονόματα μεταβλητών
2. Ονομασία Boolean
Μεταβλητές που μπορούν να έχουν μόνο δύο τιμές, δηλαδή είτε αληθής ή ψευδής, είναι γνωστά ως Boolean. Είναι ζωτικής σημασίας να επιλέγουμε κατάλληλα ονόματα για δυαδικές μεταβλητές που εκφράζουν τον σκοπό τους.
Για παράδειγμα, αντί να επιλέξετε ένα όνομα μεταβλητής όπως π.χ είναι αλήθεια, θα πρέπει να προτιμήσετε να πάτε με είναι έγκυρο ή έχει αξία.
Σκεφτείτε αυτό το παράδειγμα:
αφήνω είναι Έγκυρο = αληθής;
αφήνω hasValue = ψευδής;Σε αυτό το παράδειγμα, τα περιγραφικά ονόματα μεταβλητών boolean καθιστούν σαφές τι αντιπροσωπεύουν.
3. Λειτουργίες Ονομασίας
Μια συνάρτηση στο JavaScript αναφέρεται σε μια αυτόνομη μονάδα κώδικα που προορίζεται να εκτελέσει μια συγκεκριμένη εργασία. Είναι ένα μπλοκ κώδικα που μπορεί να κληθεί ή να κληθεί από άλλα μέρη του κώδικα και λειτουργεί ως ανεξάρτητη οντότητα.
Για να ονομάσετε αποτελεσματικά συναρτήσεις, χρησιμοποιήστε περιγραφικά ονόματα που εκφράζουν το σκοπό τους. Για παράδειγμα, αντί για δημιουργία μιας συνάρτησηςfoo, επιλέξτε πιο ενδεικτικά ονόματα όπως validateUserInput ή υπολογισμόςΣυνολικήΤιμή.
Για παράδειγμα:
λειτουργίαυπολογισμόςΣυνολικήΤιμή(τιμή, ποσότητα) {
ΕΠΙΣΤΡΟΦΗ τιμή * ποσότητα?
}
λειτουργίαvalidateUserInput(εισαγωγή) {
ΕΠΙΣΤΡΟΦΗ εισαγωγή !== απροσδιόριστος && εισαγωγή !== μηδενικό;
}
4. Σταθερές ονομασίας
Οι σταθερές είναι μεταβλητές που δεν μπορούν να αντιστοιχιστούν εκ νέου. Όταν ονομάζετε σταθερές, είναι σημαντικό να χρησιμοποιείτε όλα τα κεφαλαία γράμματα και τις κάτω παύλες για να διαχωρίζετε λέξεις.
Για παράδειγμα:
συνθ MAX_PRICE = 1000;
συνθ MIN_PRICE = 0;Σε αυτό το παράδειγμα, όλα τα κεφαλαία γράμματα και οι κάτω παύλες έχουν χρησιμοποιηθεί για τον διαχωρισμό λέξεων στα ονόματα των σταθερών.
5. Τάξεις ονοματοδοσίας
Στο JavaScript, τα αντικείμενα μπορούν να δημιουργηθούν χρησιμοποιώντας σχεδιαγράμματα που ονομάζονται κλάσεις. Για να επιτύχετε άψογες πρακτικές ονοματοδοσίας, είναι υψίστης σημασίας να εκτελέσετε το PascalCase, μια σύμβαση ονομασίας που επιβάλλει τη χρήση κεφαλαίων στο πρώτο γράμμα κάθε λέξης.
Πάρτε, για παράδειγμα:
τάξηΚαλάθι αγορών{
κατασκευαστής(μάρκα, μοντέλο) {
Αυτό.κάνω = κάνω;
Αυτό.model = μοντέλο;
}
}
Σε αυτό το παράδειγμα, η τάξη Καλάθι αγορών έχει ονομαστεί χρησιμοποιώντας PascalCase, που σημαίνει ότι το πρώτο γράμμα κάθε λέξης στο όνομα της τάξης έχει γραφτεί με κεφαλαία και δεν υπάρχουν κενά ή υπογράμμιση μεταξύ των λέξεων.
6. Ονομασία εξαρτημάτων
Τα εξαρτήματα είναι βασικά δομικά στοιχεία στη σύγχρονη ανάπτυξη λογισμικού, ιδιαίτερα σε πλαίσια όπως το React, τα οποία δίνουν έμφαση στον επαναχρησιμοποιήσιμο κώδικα.
Αναλύοντας μια πολύπλοκη διεπαφή χρήστη ή εφαρμογή σε μικρότερα, διαχειρίσιμα κομμάτια, μπορείτε να δημιουργήσετε στοιχεία που μπορούν να επαναχρησιμοποιηθούν σε διαφορετικά έργα, μειώνοντας τον χρόνο ανάπτυξης και αυξάνοντας τον κώδικα αποδοτικότητα.
Και πάλι, συνιστούμε ανεπιφύλακτα τη χρήση της σύμβασης ονομασίας PascalCase για την ονομασία στοιχείων. Αυτό σημαίνει ότι γράφεται το πρώτο γράμμα κάθε λέξης στο όνομα του στοιχείου.
Μια τέτοια σύμβαση σάς βοηθά να διακρίνετε στοιχεία από άλλα τμήματα κώδικα, απλοποιώντας την αναγνώριση και τον χειρισμό.
λειτουργίαΚουμπί(στηρίγματα) {
ΕΠΙΣΤΡΟΦΗ<κουμπί>{props.label}κουμπί>;
}Σε αυτό το παράδειγμα, η σύμβαση ονομασίας PascalCase έχει χρησιμοποιηθεί για την ονομασία του στοιχείου Κουμπί.
7. Μέθοδοι Ονομασίας
Κατά την ονομασία μεθόδων, είναι σημαντικό να χρησιμοποιείτε περιγραφικά ονόματα που επικοινωνούν με επιτυχία τι επιτυγχάνει η μέθοδος, καθώς οι μέθοδοι είναι συναρτήσεις που σχετίζονται με ένα αντικείμενο.
Για παράδειγμα:
τάξηΑυτοκίνητο{
κατασκευαστής(μάρκα, μοντέλο) {
Αυτό.κάνω = κάνω;
Αυτό.model = μοντέλο;
}
startEngine() {
// κωδικός για την εκκίνηση του κινητήρα
}
stopEngine() {
// κωδικός για να σταματήσει ο κινητήρας
}
}
}
Περιγραφικά ονόματα (εκκίνηση κινητήρα, διακοπή κινητήρα) χρησιμοποιούνται για τις μεθόδους σε αυτό το παράδειγμα, διασφαλίζοντας ότι ο σκοπός τους είναι εύκολα κατανοητός.
8. Ονομασία ιδιωτικών λειτουργιών
Οι συναρτήσεις που ορίζονται ως ιδιωτικές περιορίζονται στην πρόσβαση μόνο εντός του αντικειμένου όπου έχουν οριστεί. Είναι σημαντικό να προσθέσετε μια κύρια υπογράμμιση (_) για να υποδείξετε ότι οι λειτουργίες είναι ιδιωτικές.
Εδώ είναι ένα παράδειγμα:
τάξηΑυτοκίνητο{
κατασκευαστής(μάρκα, μοντέλο) {
Αυτό.κάνω = κάνω;
Αυτό.model = μοντέλο;
}
_startEngine() {
// κωδικός για την εκκίνηση του κινητήρα
}
_stopEngine() {
// κωδικός για να σταματήσει ο κινητήρας
}
}
Χρησιμοποιώντας μια κύρια υπογράμμιση σε αυτό το παράδειγμα, υποδεικνύεται ότι οι συναρτήσεις είναι ιδιωτικές.
9. Ονομασία καθολικών μεταβλητών
Οι μεταβλητές που ταξινομούνται ως καθολικές μπορούν να προσπελαστούν από οποιοδήποτε μέρος της βάσης κώδικα. Κατά την ονομασία τέτοιων καθολικών μεταβλητών, είναι σημαντικό να χρησιμοποιούνται σαφή και περιγραφικά ονόματα που αποδίδουν αποτελεσματικά τον επιδιωκόμενο σκοπό τους.
Για παράδειγμα:
συνθ MAX_PRICE = 1000;
συνθ MIN_PRICE = 0;
λειτουργίαέλεγχος Τιμή(τιμή) {
αν (τιμή > MAX_PRICE) {
// κωδικός για τη διαχείριση υψηλών τιμών
} αλλούαν (τιμή < MIN_PRICE) {
// κωδικός για τη διαχείριση χαμηλών τιμών
}
}
10. Ονομασία αρχείων
Η αποτελεσματική οργάνωση αρχείων είναι μια κρίσιμη πτυχή της επιτυχημένης διαχείρισης έργου JavaScript. Για να διασφαλίσετε απλοποιημένες και συνεπείς συμβάσεις ονομασίας, είναι σημαντικό να διαχωρίζετε λέξεις μέσα στα ονόματα αρχείων χρησιμοποιώντας πεζά γράμματα και παύλες.
Τα πεζά γράμματα προτιμώνται επειδή η JavaScript είναι μια γλώσσα με διάκριση πεζών-κεφαλαίων, που σημαίνει ότι η γλώσσα αντιμετωπίζει διαφορετικά τα πεζά και τα κεφαλαία γράμματα. Η χρήση πεζών γραμμάτων για τα ονόματα αρχείων διασφαλίζει τη συνέπεια και αποφεύγει τη σύγχυση κατά την αναφορά αρχείων στον κώδικα.
Οι παύλες χρησιμοποιούνται για τον διαχωρισμό λέξεων στα ονόματα αρχείων, επειδή δεν επιτρέπονται κενά στα ονόματα αρχείων. Μπορούν επίσης να χρησιμοποιηθούν και άλλες εναλλακτικές, όπως οι κάτω παύλες ή το camelCase, αλλά γενικά προτιμώνται οι παύλες για την αναγνωσιμότητά τους.
Η χρήση παύλων καθιστά επίσης τα ονόματα αρχείων πιο προσιτά για χρήστες με προγράμματα ανάγνωσης οθόνης ή άλλες βοηθητικές τεχνολογίες.
η εφαρμογή μου/
├── src/
├── συστατικά/
├── button.js
├── input-field.js
├── Utils/
├── string-utils.js
├── date-utils.js
├── app.js
├── index.jsΣε αυτό το παράδειγμα, πεζά γράμματα και παύλες χρησιμοποιούνται για τον διαχωρισμό λέξεων στα ονόματα αρχείων.
Σημασία των ακόλουθων συμβάσεων ονομασίας σε JavaScript
Η τήρηση καλών συμβάσεων ονομασίας είναι μια ουσιαστική πτυχή της σύνταξης καθαρού και συντηρήσιμου κώδικα σε JavaScript. Ακολουθώντας αυτές τις συμβάσεις, μπορείτε να κάνετε τον κώδικά σας πιο ευανάγνωστο και διατηρήσιμο, ειδικά σε ορισμένες Πλαίσια JavaScript όπου απαιτείται να χειριστείτε ογκώδη κώδικα, ο οποίος μπορεί να σας εξοικονομήσει χρόνο και προσπάθεια μακροπρόθεσμα.
