On Aug 10, 2006, at 11:10 AM, Karl Kaufmann wrote:

When I design a class, I like to  write some documentation explaining
how to use the class. I have been adding a method called "readme" where I add documentation but with the text commented out. Does this add any
excessive overhead to running a form, either in terms of the speed of
the form or the memory used?  Is there any better way to document a
class so that it is always available when I am using it?

No, unless you're at the absolute limit of available memory where having those extra 2K bytes taken up by your method will make the difference between Rushmore kicking in or not. If you're really paranoid about performance, bracket your readme method like this:

#IF .F.
This is my readme comments. They can be quite long...
...
...
This is the end of the readme.
#ENDIF

Now when your class is compiled, the readme() method will take up no memory at all.

-- Ed Leafe
-- http://leafe.com
-- http://dabodev.com





_______________________________________________
Post Messages to: [email protected]
Subscription Maintenance: http://leafe.com/mailman/listinfo/profox
OT-free version of this list: http://leafe.com/mailman/listinfo/profoxtech
** All postings, unless explicitly stated otherwise, are the opinions of the 
author, and do not constitute legal or medical advice. This statement is added 
to the messages for those lawyers who are too stupid to see the obvious.

Reply via email to