אחד ההיבטים החשובים בתכנות הוא התיעוד . התיעוד נועד לציין עובדות הנוגעות לתוכנה עבור המפתחים עצמם ועבור אנשי תחזוקת תכניות . קשה מאוד לשחזר את הרעיון שמסתתר מאחורי קטעי קוד שנכתבו במועד מסוים ללא ציון הקלט / פלט לפונקציה והרעיון המרכזי שלה . תיעוד יכיל שני מרכיבים : פירוט הערכים שמקבלת הפונקציה בעת הפעלתה . תיאור הפעולה שהפונקציה מבצעת . תיאור זה יכלול את הערך שמחזירה הפונקציה . דוגמה 7 . 7 תיעוד של פונקציה 1 . /* ------------------------------------------------------------------------ 2 . // max 3 . // ------------------------------------------------------------------------- 4 . // Return Value : unsigned char – big number out of two 5 . // Parameters : 6 . // unsigned char a – range is 0 .. 255 7 . // unsigned char b – range is 0 .. 255 8 . // Calculate the big number out of 2 . 9 . // ----------------------------------------------------------------------- */ 10 . unsigned char max ( unsigned char a , unsigned char b ) 11 . { 12 . if ( a > b ) return a ; // a is big 13 . return b ; /...
אל הספר