Naming conventions

[Dennis Brown]

Mark,

This is a good template suggestion, I will give it or something  
similar VERY serious consideration for adding to my scripts also.

Thanks,
Dennis

On Jul 3, 2005, at 12:10 PM, Mark Wieder wrote:

> Dennis-
>
> To add to your discussion of conventions:
>
> I've got a standard format for commenting my handlers that looks like
>
> --------------------------------------------
> -- HandlerName
> --
> -- Description of this block of code
> -- Uses: any global values used or external variables modified
> -- Returns: description of return value for functions
> -- Usage:
> --   HandlerName parameters
> --------------------------------------------
>
> as in:
>
> --------------------------------------------
> -- assertNotEqual
> --
> -- Causes a runtime error in the IDE if the
> -- arguments are not the same.
> --
> -- Usage:
> --
> -- on MyTest pValue
> --   assertNotEqual pValue, zero
> --   put 1000 / pValue into gSomeGlobal
> -- end MyTest
> --------------------------------------------