Level Extreme platform
Subscription
Corporate profile
Products & Services
Support
Legal
Français
Documentation
Message
General information
Forum:
Visual FoxPro
Category:
Object Oriented Programming
Title:
Miscellaneous
Thread ID:
00196873
Message ID:
00196994
Views:
27
>Hi -
>
>We are getting geared up to document (programming docs, not end-user docs) the entire program that we've worked for the past 2-1/2 years on. Since this was our first VFP and OOP project, it doesn't exactly follow good OOP pricipals.
>
>The purpose of this documentation is to clearly define the functionality and orgainization of the program, including our future plans.
>
>We are thinking about using some sort of UML program (Visual Modeler, Rational Rose or maybe even Visio) to do this.
>
>Any advice? I feel like I am looking up at a mountain with a teaspoon in my hand.....
>
>
>TIA -
>~ ellen
Depending on how involved your docs might be, there are a couple of different ways to approach this. A quick and easy way of documenting your classes is to download a program from UT called "DOCVCX". It will read your class libraries and produce documentation in Word. It's pretty cool, and it's free.

Another option is to take a look at West Wind Technologies. There HTML Help Builder is designed to help you create HTML-based documentation of your classes/code. Another cool program.

If you've got Visual Studio, try using the VFP Wizards to export your classes to Visual Modeler. It will help you create graphical documentation of your classes. It works OK, but it might take a little work to make things look nice.
-Paul

RCS Solutions, Inc.
Blog
Twitter
Previous
Next
Reply
Map
View

Click here to load this message in the networking platform