כתיבת הערות בתסריטים בסיסיים

כשאתה כותב סקריפטים של באש, זה תמיד נוהג להפוך את הקוד שלך לנקי וקל להבנה. ארגון הקוד שלך בלוקים, הזחה, מתן משתנים ופונקציות שמות תיאוריים הם כמה דרכים לעשות זאת.

דרך נוספת לשפר את הקריאות של הקוד שלך היא באמצעות הערות. הערה היא הסבר או ביאור קריא לבני אדם הכתובים בתסריט הקונכיות.

הוספת הערות לתסריטים של ה- Bash תחסוך לך הרבה זמן ומאמץ כשאתה מסתכל על הקוד שלך בעתיד. נניח שאתה רוצה לשנות תסריט שכתבת לפני מספר חודשים או שנים. רוב הסיכויים שלא תזכרו מדוע כתבתם איזה פיסת קוד מסובכת אלא אם כן הוספתם תגובה.

התגובות עוזרות גם למפתחים ומנהלי מערכות אחרים שעשויים להזדקק לתחזוק התסריט להבנת הקוד שלך ומטרתו.

בדרך כלל משתמשים בתגובות כדי להסביר מה הקוד לא יכול. לדוגמה, אם יש לך regex מורכב או החלפת פרמטרים בתוך סקריפט ה- Bash שלך, עליך לכתוב תגובה על מה שהקוד עושה. התגובות צריכות להיות קצרות ולעניין. אל תסביר משהו שהוא פשוט ומובן מאליו לקורא.

, נסקור את היסודות של כתיבת תגובות בבאש.

כתיבת תגובות בבש

באש מתעלם מכל מה שנכתב אחרי סימון החשיש ( # ) על הקו. החריג היחיד לכלל זה הוא כאשר השורה הראשונה בתסריט מתחילה ב- #! תווים. רצף תווים זה נקרא Shebang ומשמש להגיד למערכת ההפעלה באיזה מתורגמן להשתמש כדי לנתח את שאר הקובץ.

ניתן להוסיף הערות בתחילת הקו או בשורה עם קוד אחר:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

הרווח הריק אחרי סימון החשיש אינו חובה, אך הוא ישפר את הקריאות של התגובה.

בדרך כלל, כאשר התסריט נפתח בעורך טקסט, התגובות מיוצגות בירוק.

הערות מועילות גם בבדיקת סקריפט. במקום למחוק כמה שורות או חסימות, תוכלו להגיב עליהם:

# if]; then # echo "Variable is greater than 10." # fi

הערות רב-שורות בבש

בשונה מרוב שפות התכנות, בש אינו תומך בתגובות מרובות-שורות.

הדרך הפשוטה ביותר לכתוב הערות רב-שורות בבאש היא להוסיף הערות בודדות זו אחר זו:

# This is the first line. # This is the second line.

אפשרות נוספת היא להשתמש ב- HereDoc. זהו סוג של ניתוב מחדש המאפשר לך להעביר מספר שורות קלט לפקודה. אם חסימת HereDoc לא מנותבת לפקודה, היא יכולה לשמש כמציין מיקום בהערות מרובות-שורות:

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

השימוש ב- HereDoc הוא פריצה, ולא דרך מובנית אמיתית לכתוב הערות באש רב שכבתי. כדי להימנע מבעיות כלשהן, עליך להעדיף להשתמש בתגובות בשורה אחת.

סיכום

כתיבת תגובות היא פרקטיקה טובה ועוזרת למפתחים אחרים, כולל עצמי עתידי, להבין את סקריפט הפגז. בבאש, הכל אחרי סימון החשיש ( # ) ועד סוף התור נחשב כהערה.

אם יש לך שאלות או משוב, אל תהסס להשאיר תגובה.

מסוף bash