Level Extreme platform
Subscription
Corporate profile
Products & Services
Support
Legal
Français
Documentation of a Process
Message
From
02/12/2003 15:46:51
 
 
To
02/12/2003 09:19:44
Jay Johengen
Altamahaw-Ossipee, North Carolina, United States
General information
Forum:
Visual FoxPro
Category:
Other
Miscellaneous
Thread ID:
00854986
Message ID:
00855177
Views:
19
Renoir --

Folks who make a study of documentation suggest special patterns in comments. You could use any number of codes following * and && to indicate header comment, line comment, and indentation, if you want to get that specific. You can grab the comments alone, and, if desired, provide indentation or other useful formatting. Works fine for text only procedure libraries and text-based class libraries. Folks working in Java have developed an XML format which makes the comment type more clear in the code itself.

Jay

>I need to document a process that encompasses complex calculations. It includes array manipulations, UDFs, calls to various programs, etc. I have done this in the past and used a simple outline to do it. Though it covered every part of the process I wasn't satisfied with the readability of the document. It was hard to show calls to other programs and functions for one thing. I think it's too early in the documentation process to use a flowchart - that will be part of the final stage - but I wondered if anyone had any suggestions. I use PDM to document the project as a whole, but it only works at a "block" level, not line by line. I need to document everything that is happening on a line by line basis and turn it into a psuedo-code document so we can analyze and rewrite the calculations. Thanks!
>
>Regards, Renoir
Previous
Next
Reply
Map
View

Click here to load this message in the networking platform