|
-
May 7th, 2021, 03:21 AM
#18
Re: (VB6) Component Documenter
 Originally Posted by xiaoyao
Listing all the attributes and methods is a normal practice, so it can be made into an independent module.
About how to collate the later data. For example, each method can write its own test project. Or a line of test code.
That would be some other tool. This one is only to document.
But you could write it. The only thing in common would be the use of TLBINF32.DLL.
 Originally Posted by xiaoyao
For example, I especially like to write these English names in Chinese, that is, every attribute method should be translated.
And add the problems encountered in the learning process to be recorded.
I don't think that translating the members and parameters names would be a good idea, since the reader need to learn the names that they will have in the development environment, she/he needs to get familiar with them even when they are in another language.
But I've thought about handling different languages in the program to output the information to different languages, or even automating Google translator to help you to translate from one language to another.
That would be on version 2 or 3, if at any point they come.
Anyway, I think developers need to get used to read technical information in English.
It is time consuming to make documentation in one language, not to say making (and maintaining) it in many.
And other point is that Google translation need to be manually revised, it is not right every time, and... if you don't know the language and cannot hire a human translator to perform the revision... the output won't be as good.
Posting Permissions
- You may not post new threads
- You may not post replies
- You may not post attachments
- You may not edit your posts
-
Forum Rules
|
Click Here to Expand Forum to Full Width
|