RE: Source Code Documentation Systems?

Subject: RE: Source Code Documentation Systems?
From: "Smith, Martin" <martin -dot- smith -at- encorp -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 24 Jan 2001 09:08:19 -0700

I have written scripts in FrameScript that parse our source code, identify
variable declaration statements, locate the corresponding comments,
concatenate multi-line comments into a paragraph, strip garbage characters,
and then generate an alphabetized reference manual in FrameMaker. I'm not
sure I would invest in a program to perform these tasks when the processing
that needs to be done is unique in each case. Such scripts are quite simple
to develop, taking less than a day to perfect.

The resulting document describes more than 1000 variables built into our
firmware. The generated document is by no means perfect and is intended only
for use by developers. Nonetheless, this is a convenient way to generate
documents that provide a snapshot of rapidly changing code. The value that
the script provides is the ability to generate the document as often as
needed. If I needed to produce a manual for customers I would view the
generated document as a good starting point, nothing more. I would need to
rewrite and elaborate on each comment in order to produce a manual suitable
for an external audience.

Martin

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17)
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area.
http://www.pdfconference.com or toll-free 877/278-2131.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: RE: Industry Standard?
Next by Author: RE: OT: (almost) Blank Pages
Previous by Thread: Re: Source Code Documentation Systems?
Next by Thread: RE: Source Code Documentation Systems?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads