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