Naming conventions

[Dennis Brown]

Mark/All,

Is there any advantage to putting the main block of comments outside  
the handler vs inside the handler?

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
> --------------------------------------------
>
> -- 
> -Mark Wieder
>  mwieder at ahsoftware.net
>
>
> _______________________________________________
> use-revolution mailing list
> use-revolution at lists.runrev.com
> Please visit this url to subscribe, unsubscribe and manage your  
> subscription preferences:
> http://lists.runrev.com/mailman/listinfo/use-revolution
>