שפר את הקריאות והתחזוקה של קוד ה-JavaScript שלך על ידי ביצוע מוסכמות השמות האלה.
חיוני לשמור על פשטות, קריאות וקלות תחזוקה בקוד שלך כדי לנהל פרויקטים מורכבים של JavaScript. שמירה עקבית על מוסכמות השמות היא המפתח להשגת מטרה זו.
משתנים, בוליאניים, פונקציות, קבועים, מחלקות, רכיבים, שיטות, פונקציות פרטיות, משתנים גלובליים וקבצים הם בין מרכיבי JavaScript הדורשים מוסכמות שמות עקביות. אתה יכול לשפר את ארגון והבנת הקוד על ידי הטמעת מוסכמות שמות סטנדרטיות בכל הרכיבים הללו, ולחסוך זמן ומאמץ בטווח הארוך.
1. מתן שמות למשתנים
ב-JavaScript, הנתונים מאוחסנים במשתנים. חיוני לבחור שמות תיאוריים למשתנים המשקפים במדויק את תפקידם. אתה יכול, למשל, להחליף שם משתמש אוֹ מחיר סופי לשם של משתנה במקום איקס.
דרך טובה לתת שם למשתנים היא כדלקמן:
לתת סך המחיר = 100;
לתת שם משתמש = "ג'ון";
ניתן להשיג קריאת קוד משופרת על ידי שימוש בשמות משתנים תיאוריים
2. מתן שם בוליאני
משתנים שיכולים להיות בעלי שני ערכים בלבד, כלומר, או נָכוֹן אוֹ שֶׁקֶר, ידועים כבוליאנים. חשוב לבחור שמות מתאימים למשתנים בוליאניים המבטאים את מטרתם.
לשם המחשה, במקום לבחור בשם משתנה כגון נכון, אתה צריך להעדיף ללכת עם הוא תקף אוֹ יש ערך.
שקול את המקרה הזה:
לתת isValid = נָכוֹן;
לתת hasValue = שֶׁקֶר;
בדוגמה זו, שמות משתנים בוליאניים תיאוריים מבהירים מה הם מייצגים.
3. מתן שמות לפונקציות
פונקציה ב-JavaScript מתייחסת ליחידת קוד עצמאית שנועדה לבצע משימה מסוימת. זהו גוש קוד שניתן לקרוא לו או להפעיל אותו על ידי חלקים אחרים של הקוד והוא פועל כישות עצמאית.
כדי לתת שם ביעילות לפונקציות, השתמש בשמות תיאוריים המעבירים את מטרתן. למשל, במקום יצירת פונקציהפו, בחר בשמות ממחישים יותר כמו validateUserInput אוֹ לחשב מחיר כולל.
לדוגמה:
פוּנקצִיָהלחשב מחיר כולל(מחיר, כמות) {
לַחֲזוֹר מחיר * כמות;
}
פוּנקצִיָהvalidateUserInput(קֶלֶט) {
לַחֲזוֹר קלט !== לא מוגדר && קלט !== ריק;
}
4. מתן שם קבועים
קבועים הם משתנים שלא ניתן להקצות מחדש. בעת מתן שמות קבועים, חשוב להשתמש בכל האותיות הגדולות והקו תחתון כדי להפריד בין מילים.
לדוגמה:
const MAX_PRICE = 1000;
const MIN_PRICE = 0;
בדוגמה זו, כל האותיות הגדולות והקו תחתון שימשו להפרדת מילים בשמות הקבועים.
5. כיתות מתן שמות
ב-JavaScript, ניתן ליצור אובייקטים באמצעות שרטוטים הנקראים מחלקות. כדי להשיג שיטות שמות ללא רבב, ישנה חשיבות עליונה לבצע את PascalCase, אמנת שמות המחייבת שימוש באותיות גדולות באות הראשונה בכל מילה.
קח, למשל:
מעמדעגלת קניות{
בַּנַאִי(ייצור, דגם) {
זֶה.make = לעשות;
זֶה.model = model;
}
}
בדוגמה זו, הכיתה עגלת קניות קיבל שם באמצעות PascalCase, כלומר האות הראשונה של כל מילה בשם המחלקה הוכנסה באותיות רישיות, ואין רווחים או קווים תחתונים בין המילים.
6. מתן שמות לרכיבים
רכיבים הם אבני בניין חיוניות בפיתוח תוכנה מודרני, במיוחד ב מסגרות כמו React, המדגישים קוד לשימוש חוזר.
על ידי פירוק ממשק משתמש מורכב או יישום לחתיכות קטנות יותר וניתנות לניהול, אתה יכול ליצור רכיבים שניתן לעשות בהם שימוש חוזר בפרויקטים שונים, תוך צמצום זמן הפיתוח והגדלת הקוד יְעִילוּת.
שוב, אנו ממליצים בחום להשתמש במוסכמות השמות של PascalCase למתן שמות לרכיבים. משמעות הדבר היא שימוש באותיות רישיות באות הראשונה של כל מילה בשם הרכיב.
מוסכמה כזו מסייעת לך להבחין בין רכיבים מקטעי קוד אחרים, ומפשטת את הזיהוי והמניפולציה.
פוּנקצִיָהלַחְצָן(אביזרים) {
לַחֲזוֹר<לַחְצָן>{props.label}לַחְצָן>;
}
בדוגמה זו, נעשה שימוש במוסכמות השמות של PascalCase כדי לתת שם לרכיב לַחְצָן.
7. שיטות מתן שמות
בעת מתן שמות לשיטות, חיוני להשתמש בשמות תיאוריים המעבירים בהצלחה את מה שהשיטה משיגה מכיוון ששיטות הן פונקציות הנוגעות לאובייקט.
לדוגמה:
מעמדאוטו{
בַּנַאִי(ייצור, דגם) {
זֶה.make = לעשות;
זֶה.model = model;
}
התנע מנוע() {
// קוד להפעלת המנוע
}
stopEngine() {
// קוד לעצירת מנוע
}
}
}
שמות תיאוריים (התנע מנוע, stop Engine) משמשים לשיטות בדוגמה זו, מה שמבטיח שהמטרה המיועדת שלהן מובנת בקלות.
8. מתן שמות לפונקציות פרטיות
פונקציות המוגדרות כפרטיות מוגבלות לגישה רק בתוך האובייקט שבו הן מוגדרות. חשוב להוסיף קו תחתון מוביל (_) כדי לציין שהפונקציות הן פרטיות.
הנה דוגמה:
מעמדאוטו{
בַּנַאִי(ייצור, דגם) {
זֶה.make = לעשות;
זֶה.model = model;
}
_התנע מנוע() {
// קוד להפעלת המנוע
}
_stopEngine() {
// קוד לעצירת מנוע
}
}
על ידי שימוש בקו תחתון מוביל בדוגמה זו, מצוין שהפונקציות הן פרטיות.
9. מתן שמות למשתנים גלובליים
ניתן לגשת למשתנים המסווגים כגלובליים מכל חלק בבסיס הקוד. בעת מתן שמות למשתנים גלובליים כאלה, חיוני להשתמש בשמות ברורים ותיאוריים המעבירים ביעילות את מטרתם המיועדת.
לדוגמה:
const MAX_PRICE = 1000;
const MIN_PRICE = 0;
פוּנקצִיָהcheckPrice(מחיר) {
אם (מחיר > MAX_PRICE) {
// קוד לטיפול במחירים גבוהים
} אַחֵראם (מחיר < MIN_PRICE) {
// קוד לטיפול במחירים נמוכים
}
}
10. מתן שמות לקבצים
ארגון קבצים יעיל הוא היבט מכריע בניהול פרויקטים מוצלחים של JavaScript. כדי להבטיח מוסכמות שמות יעילות ועקביות, חיוני להפריד בין מילים בתוך שמות קבצים באמצעות אותיות קטנות ומקפים.
אותיות קטנות עדיפות מכיוון ש-JavaScript היא שפה הרגישה לאותיות גדולות, כלומר השפה מתייחסת לאותיות קטנות ואותיות רישיות בצורה שונה. שימוש באותיות קטנות עבור שמות קבצים מבטיח עקביות ומונע בלבול בעת הפניה לקבצים בקוד.
מקפים משמשים להפרדת מילים בשמות קבצים מכיוון שאסור להשתמש ברווחים בשמות הקבצים. ניתן להשתמש גם בחלופות אחרות כגון קווים תחתונים או camelCase, אך מקפים מועדפים בדרך כלל בשל קריאותם.
השימוש במקפים גם הופך את שמות הקבצים לנגישים יותר עבור משתמשים עם קוראי מסך או טכנולוגיות מסייעות אחרות.
my-app/
├── src/
├── רכיבים/
├── button.js
├── input-field.js
├── שימושים/
├── string-utils.js
├── date-utils.js
├── app.js
├── index.js
בדוגמה זו, אותיות קטנות ומקפים משמשים להפרדת מילים בשמות הקבצים.
חשיבות הקפדה על מוסכמות שמות ב-JavaScript
מעקב אחר מוסכמות שמות טובות הוא היבט חיוני בכתיבת קוד נקי וניתן לתחזוקה ב-JavaScript. על ידי ביצוע המוסכמות הללו, תוכל להפוך את הקוד שלך לקריא וניתן יותר לתחזוקה, במיוחד בחלקם מסגרות JavaScript שבהן אתה נדרש לטפל בקוד מגושם, שיכול לחסוך לך זמן ומאמץ ב- טווח ארוך.