בעת תכנות במחשב, לפעמים יש צורך להשאיר הערות או הערות כדי שמפתחים אחרים יוכלו לעיין בקוד שלך בקלות. בין אם מדובר בפרויקט קוד פתוח או בפרויקט קנייני, יש צורך בהערות על מנת לתאם עם מפתחים משותפים ומפתחים עתידיים אפשריים גם כן. ללא הערות, הקוד פשוט לא ניתן לתחזוקה.
צעדים
שלב 1. להבין את מטרת ההערה לתוכנית מחשב
- קריאות היא הדבר המרכזי כאן. כשאתה מסתכל על תגובה אתה צריך לדעת שזו הערה ולא שורת קוד.
- ההערה אמורה להיות מועילה לא רק לך, אלא לכל מי שעשוי לקרוא את קוד המקור של תוכנית המחשב שלך.
שלב 2. תחשוב על דרך קצרה ופשוטה להעביר את הנקודה שלך
הערות לא צריכות להיות יצירת אמנות. הם צריכים להיות תמציתיים, מסודרים וישרים לעניין.
עם זאת, אין בכך כדי להרתיע את השימוש במספר שורות להערה. הנקודה היא שהמידע צריך לעבור לקורא
שלב 3. כתוב את ההערה באמצעות התחביר המתאים על ידי שפת התכנות
שלב 4. שאל את עצמך אם ההערה שכתבת מפורטת מספיק
הערה אמורה להיות מסוגלת לספר למי שמסתכל על קוד המקור מה החלק הזה של התוכנית בעצם עושה מבלי שתצטרך לאסוף אותו ולהריץ אותו. האם ההערה שלך משיגה זאת? האם הוא מעביר את כל הפרטים?
