Versions des environnements
>>>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.
Précédent
Suivant
Répondre
Voir le fil de ce thread
Voir le fil de ce thread à partir de ce message seulement
Voir tous les messages de ce thread
Voir tous les messages de ce thread à partir de ce message seulement