Level Extreme platform
Subscription
Corporate profile
Products & Services
Support
Legal
Français
What class to use for documentation
Message
From
03/07/2009 10:38:14
Hilmar Zonneveld
Independent Consultant
Cochabamba, Bolivia
 
General information
Forum:
Visual FoxPro
Category:
Other
Environment versions
Visual FoxPro:
VFP 9 SP1
Miscellaneous
Thread ID:
01409893
Message ID:
01409918
Views:
52
>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.

Wouldn't it be simpler to include methods directly in each class, for documentation purposes?

For example, each class could have a method "About", which explains the purpose of the class. There might be a separate method "Changelog", if you prefer to keep that part separate.

Yet another option for the changelog is to have a table in a separate Word document. You can reserve columns for the class names. You might even use a DBF for this purpose, to make it easier to find information on specific classes.
Difference in opinions hath cost many millions of lives: for instance, whether flesh be bread, or bread be flesh; whether whistling be a vice or a virtue; whether it be better to kiss a post, or throw it into the fire... (from Gulliver's Travels)
Previous
Next
Reply
Map
View

Click here to load this message in the networking platform