>>>>>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.
>>>
>>>You are right. There are many different ways (each has pros and cons) of documenting. I am still searching for something that I can stick to. I know that problem is mostly with me and not with the approach <g>.
>>>
>>>Thank you.
>>
>>I don't think many developers enjoy documenting. It's scut work.
>
>It is not that I don't enjoy it but rather that I am not consistent. I have tons of documentation (in different places, different formats). What happens is that say 6 months from now a customer calls with an issue pertaining to what I am working on right now. It takes me a great deal of time to even figure out what the hell he/she is talking about. If I had one place where things would be logically defined/described it would take 5 minutes just to read this stuff. As I said I keep changing my documentation approach and don't stick with one that I would be comfortable always. This is why I said that I need to change. But as you know, we, men, don't change <g>.

Dmitry,

I have a zzDocs method in every class of my first sub-class off of the VFP classes. As you said, sorts to the bottom.
The first one is #IF .F. #ENDIF

Each subclass gets a reason for the change in there and I can view parent code all the way to the top when designing. I use this for the general overview of a class or a change. I document the details where the change is made. I also use it for a dump of test code or template code, since I can go the parent and copy it to the new subclass for the test or the template.

Useful for me anyway.

Al Allison