כיצד להוסיף הערות על קטע קוד ב-Python

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

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

מדוע תגובות בסבך חשובות ב Python?

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

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

שימוש בתגיות ההערה הסינגליסטים בפיתוח

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

1. מיקום: שימו את הסימן # בתחילת השורה או אחרי הקוד באותה שורה. ערות יכולות להיות מנוחות למעלה מהקוד שהן מתייחסות אליו, על אותה שורה מימין לקוד, או לבד.
2. תוכן: אחרי הסימן #, כתבו את הערה שלכם. זה יכול להיות הסבר לשורה הקוד, הערה לשימוש בעתיד, או כל מידע שיעזר בקשר לקוד.

# זוהי ערה סינגליסטית ספציפית המפרשת את השורה הבאת של הקוד
print("Hello, world!")  # זה מדבר מסר אל המסך

שיטה #1: הערה בעזרת מספר ערות סינגליסטיות בודדות.

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

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

תוכל לראות את הדוגמה הבאה:

# דוגמה להוספת תגובה למספר שורות באופן פרטי
# def example_function(name):
# 	# הפונקציה הזו מדפיסת "Hello " ושם הזהירה שמופיע
# 	print("Hello", name)

שיטת תגובת בלוק בפייתון מספר 2: הוספת תגובה באמצעות מחרוזות עם ציטוטיות משולשות

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

'''
def example_function(name):
	print("Hello", name)
'''

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

# יצירת example_function()
def example_function(name):
	'''
	This function takes as input a name, and returns a salutation to the name in the form of "Hello name"
	'''
	# הדפסת הפלט 
	print("Hello", name)

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