The Lush Engine

Commenting code standards

All code found within the Lush project is fully commented. This means that the files become larger, but this has absolutely no effect on the resulting code, it just takes a slightly longer time to assemble as the assembler has to read through and ignore some additional lines.

It does mean, however, that the code is more readable, adaptable, and understandable by coders other than the one who wrote the code.

Each procedure will have the following heading:

;*******************************************************************
; Procedure Name  : exact name of the procedure
;
; Author          : name and alias of the coder who wrote the
;                 : procedure
;
; Description     : Brief description of what the procedure does.
;                 : Additional lines are inserted as neccessary
;
; On Entry        : What registers need to be set, with what value
;
; During          : What registers are modified during the procedure
;
; On Exit         : What registers are intentionally set to hold
;                 : values on exit
;*******************************************************************