Level Extreme platform
Subscription
Corporate profile
Products & Services
Support
Legal
Français
What class to use for documentation
Message
 
 
To
03/07/2009 09:26:09
General information
Forum:
Visual FoxPro
Category:
Other
Environment versions
Visual FoxPro:
VFP 9 SP1
Miscellaneous
Thread ID:
01409893
Message ID:
01409909
Views:
34
>>Hi,
>>
>>I want to add a class to every class library of my project to document changes in the library. The class name will always be starting with "zz" and therefore will be at the bottom of the names of classes. I will probably have to add a custom method to this documentation class (e.i. 'documentation') where I will be typing plain text of changes/descriptions. I have two questions:
>>
>>1. If I comment this text using NOTE it will not be included in the compiled .exe, right?
>>2. What is the lightest class to use for documentation that will increase the size of .vcx and the .exe the least?
>>
>>Thank you in advance.
>
>(1) no - use #if false #endif
>Nicer also - you do not have to comment out each line
>Only drawback is the lines cannot start with #

Hi Gregory,

I thought the same, but my quick experiments contradict this. Could you please try as well? Or may be I made a wrong experiment?


>
>(2) You can add a dummy method to every class - does not need to be a separate class
>
>If you do want to create a separate class - put it in a separate vcx and do not include it
>
>Alternatively: You can also put the doc changes in word docs/html ... Add them to the project and do not include them

My former colleague in Boston included .txt file (excluded) with all changes.
If it's not broken, fix it until it is.


My Blog
Previous
Next
Reply
Map
View

Click here to load this message in the networking platform