מהות
באמצעות הערות בין שורות הקוד תוכל להסביר את הקוד, להדגיש נקודות חשובות, להסביר שורה מסובכת במיוחד וכו'.
קוים מנחים
- תוכניתן שרוצה להבין במהירות את האלגוריתם שלך לא רוצה לעבור שורה שורה בניסיון לפענח למה התכוונת בכתיבת השורות.
- תוכניתן ממוצע מבין פקודות פשוטות והקשרן בתוכנית. הצורך בתיעוד נוסף נוצר בקטעים לוגיים מסובכים.
- כשההערות הן סתמיות (חסרות תוכן, או שוות ערך בדיוק לקוד) לא שווה לקרוא אותן. הן סתם גוזלות זמן ועלולות להיות מיושנות או שגויות.
- קשה לתעד קטע קוד שאתה בעצמך לא בטוח מה הוא עושה, או אפילו לא סגור על הפרטים הקטנים שלו.
הסבר
חשוב לכתוב את ההערות קרוב לזמן כתיבת הקוד עצמו, כדי שההערות יהיו כמה שיותר נאמנות לקוד ומדויקות. הזמן המתאים ליצירת תיעוד הוא מיד לאחר כתיבת קטע מסוים. בצורה כזו לא יהיו סתירות בין הקוד להערות ולא יגרם בלבול לתוכניתן הקורא את התוכנית.
נשאלת השאלה - כמה לתעד ? אין לשאלה תשובה אחת, חייבים להפעיל פה שיקול דעת. ככל שתכתבו תוכניות רבות יותר, תפתחו חוש לכמות התיעוד הנדרשת לכל קטע קוד. יש להסביר חלקים לוגיים בתוכנית, או פקודות מסובכות ולא שגרתיות. דברים בסיסיים וחלקים לוגיים פשוטים מאוד אין צורך לפרט.
דוגמאות
// Print name of user
cout << “Name of user is: %s << strUserName << endl;
הערה גרועה ולא תורמת. אפשר להבין את משמעות הפקודה גם ללא קריאת ההערה
// Sort the array
for (i = 0; i < NO_OF_CELLS; ++i)
{
כאן יבוא הקוד למיון
}
הערה טובה. יש קטע לוגי אחד בתוך הלולאה, ובמקום לקרוא את כל הקוד הפנימי, אפשר פשוט להסתכל בהערה ולחסוך קריאת שורות קוד רבות
// Read the names
cin >> szFirstName >> szLastName;
while(!(strcmp(srtFirstName, NAME_LIST_END) == 0))
{
...
...
...
cin >> szFirstName >> szLastName;
}
הערה טובה. תעוד הוא לקטע לוגי, לכן ההערה מכסה את כל מבנה לולאת הזקיף, לא רק את ה-while (כנ"ל לגבי if)
גולשים מקוונים: 6