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

הערה לשגרה דומה בתפקידה להערה ראשית לתוכנית. גם היא נועדה לתת רקע כללי על קטע הקוד שכתבנו, ולהסביר בכמה מילים על תפקיד השיגרה ועל תפקידה במערכת כולה.

 

מבנה

  1. כללי (General) - יסביר מה השגרה עושה ובמידה והיא מאוד מסובכת אז גם אופן פעולתה הכללי.
  2. פרמטרים (Parameters) - הפרמטרים שהשגרה מקבלת, והסבר קצר על תפקיד כל אחד מהם. לכל פרמטר כתוב את כיוון זרימת המידע שלו. (In, Out, In/Out)
  3. ערך החזר (Return Value) - משמעותו של ערך ההחזר בתוכנית. אם ישנם מקרי קצה מסוימים בהם השגרה מטפלת בצורה שונה יש לציין זאת כאן.

דוגמא

 

//---------------------------------------------------------------
//                              CalcHeightDelta
//
//  General: This function calculates the height delta between two
//           geographic points based on the class's carpet of heights
//
//  Paramters: 
//          Point1: first point (in)
//          Point2: second point (in)
//          
//  Return Value: The height difference between the two points
//
//---------------------------------------------------------------
// programmer: Yossi Humus
// Date: October, 1978

 08-04-04 / 03:18  עודכן ,  20-03-04 / 17:22  נוצר ע"י ישי קנובל בתאריך 
 הערה ראשית לתכנית - הקודםהבא - הערות לוגיות 
תגובות הקוראים    תגובות  -  0
דרכונט
מהי מערכת הדרכונט?
אינך מחובר, להתחברות:
דוא"ל
ססמא
נושאי לימוד
חיפוש  |  לא פועל
משלנו  |  לא פועל
גולשים מקוונים: 4