הערה לשגרה דומה בתפקידה להערה ראשית לתוכנית. גם היא נועדה לתת רקע כללי על קטע הקוד שכתבנו, ולהסביר בכמה מילים על תפקיד השיגרה ועל תפקידה במערכת כולה.
מבנה
- כללי (General) - יסביר מה השגרה עושה ובמידה והיא מאוד מסובכת אז גם אופן פעולתה הכללי.
- פרמטרים (Parameters) - הפרמטרים שהשגרה מקבלת, והסבר קצר על תפקיד כל אחד מהם. לכל פרמטר כתוב את כיוון זרימת המידע שלו. (In, Out, In/Out)
- ערך החזר (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