Documentation of global variables

[mluka]

Hi all.

Is there a "best practice" on how (and where) to document the global variables used in a solution?

Thanks!

[BrentHedden]

I've never heard of a 'best' way to do this, but I initially have a white board that has them all written down and to which file it belongs to (if a multi-file solution). Once I'm done with the solution, I create an electronic document of everything on the white board, so I can refer back to later if need be.

It also might be helpful to have a brief description of what each one is for, and what info it might or should contain. But I just use script comments for that.

Regular or local variables I don't worry too much about documenting, except for adding a script comment.

[Søren Dyhr]

BrentHedden is right there is probably no ideal way to document them, except staying away from them so they always only live in just one object as local, by using script results instead.

The key to it, is to regard the tool a little more object oriented, this means sparsingly use of anything global, being it fields or paramters. Perhaps you should regard the use of globals a rescue only, not something to be used on a daily basis!!!

Two scripting techniques makes the use of globals as such, easy to avoid:

Either this:

http://edoshin.skeletonkey.com/2006/02/options.html#more

or this:

http://fmforums.com/forum/showpost.php?post/187787/

--sd