» נושאי לימוד
» נושאי לימוד
יום ראשון 1 בדצמבר 2024
תיעוד
דף ראשי  תיעוד גרסה להדפסה

 

הצורך בתיעוד הוא החלק הכי פחות ברור לתוכניתן המתחיל.

 

"למה צריך לכתוב מה הקוד הזה  עושה?

הרי ברור מה עושים פה!

ואם מישהו לא מבין - שישאל אותי!"

אז ככה:

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

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

חשוב מאוד להבין שלא על כמות התיעוד יש לשים את הדגש אלא על האיכות.

 

הערה שאומרת במילים מה הפקודה עושה לא מוסיפה ואף גורעת:

(Ïncrementing the counter by one)

 

לעומת זאת, הערה שמסבירה את הלך המחשבה של התוכניתן תסייע גם למפתח הקוד להימנע מבאגים וגם למתחזק הקוד למצוא אותם.
(Assuming ont or more than one element in the array and calculating its average)

 

 08-04-04 / 01:35  עודכן ,  26-09-03 / 23:52  נוצר ע"י ישי קנובל  בתאריך 
 שאלות חזרה - הקודםהבא - הערה ראשית לתכנית 
תגובות הקוראים    תגובות  -  0
דרכונט
מהי מערכת הדרכונט?
אינך מחובר, להתחברות:
דוא"ל
ססמא
נושאי לימוד
חיפוש  |  לא פועל
משלנו  |  לא פועל
גולשים מקוונים: 1