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

הערה ראשית מסבירה את פעולת התוכנית ברמה הכללית וקשרים שלה לעולם החיצון לקורא שלא מכיר אותה.

 

קוים מנחים

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

מבנה

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

ארבעת הסעיפים יופיעו תמיד, ובמקרה שאין מה לכתוב באחד מהם יש לציין None.

 

דוגמא

 

//---------------------------------------------------------------
//                              CarDistanceMeter
//
//  General: This function calculates the remaining distance a car
//           can ride without refueling 
//
//  Input:  Fuel left in tank,
//          the car's fuel consumption.
//
//  Process: ....
//
//  Output: Distance in km
//---------------------------------------------------------------
// programmer: Duvid Schweizer
// Date: July, 1974

 

הערה ראשית כדוגמת זו תבוא בראש כל תוכנית שנכתוב.
להערה מבנה קבוע שמקל על הבנת התהליכים המרכזיים בתוכנית. מבנה אחיד וקשיח מאפשר להגדיר בצורה אחידה את משמעות כל סעיף, ללא דו משמעויות ואי דיוקים.
לדוגמא: אם אין סעיף קלט, אז אין קלט, או ששכחו אותו?
פתרון: הסעיף תמיד יופיע, ובמקום התאור שלו נרשום None.
 
ישנו חלק של עידכונים (Updates) אותו נהוג למלא בפרוייקטי תוכנה גדולים שמתמשכים לאורך פרק זמן ארוך, וזאת לאחר שמבצעים עדכון בגרסת התוכנית. בצורה כזו אפשר לעקוב אחר השינויים שהתבצעו בקוד במשך פיתוח הפרוייקט.
 
                                                         
 08-04-04 / 03:17  עודכן ,  06-10-03 / 13:38  נוצר ע"י ישי קנובל  בתאריך 
 תיעוד - הקודםהבא - הערה לשגרה 
תגובות הקוראים    תגובות  -  0
דרכונט
מהי מערכת הדרכונט?
אינך מחובר, להתחברות:
דוא"ל
ססמא
נושאי לימוד
חיפוש  |  לא פועל
משלנו  |  לא פועל
גולשים מקוונים: 3