|
Copy & paste this, one per procedure; Name your page with your procedure name. Procedure/routine documentation: Name of Routine: Writer's name: Most recent update Date: Credits: Who helped with what. Brief description: Inputs: and Preconditions: I use: - Passed-in variables: What, and Where are they found?
- . . . Passed on stack: (by value /by reference ?)
- . . . Passed in register( )
- Preconditions, other: I expect what to be true?
Outputs and Postconditions: I Change in computer: - Return value in register ( ):
- Other "Side effects" Screen output, flag, other?
- Postcondition I leave things in what state?
Procedure(s) I call: Routine(s) that call me: Add to Memory Globals sheet if necessary Status: (Top level, written but not tested, buggy, CLEAN AND DONE) Internal documentation: top level description + Code, with "test driver" and results of test runs, and should follow this: Sign your code; comments top and bottom ;--- --- E.D. Student begin--- --- , etc.
|