Re: Source Code Documentation Systems?

Subject: Re: Source Code Documentation Systems?
From: Scott Turner <sturner -at- airmail -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 23 Jan 2001 22:42:38 -0600

I come across ads here and there for these systems, marketed to
developers, which typically claim to find objects and comments in source
code (Java, C, C++), create some kind of documentation based on these
and output to RTF, HTML, HTML help.

Has anyone ever worked with systems like these, or had to write actual
user material from the output they generate? I'm wondering how useful
these systems might be for creating user documents. Especially if they
are outputting to help, it would seem that's what they are trying to do.


Javadoc, provided as part of the JDK package does this. To be sure, it is very valuable when you want to document the classes, objects, variables, methods, behavoirs, etc. It doesn't write much. It is more like a smart concordance generator, or index generator.

You still have to write context and meaning into the docuement.

I am currently doing reverse engineering at my present position to create a functional description of our software. Using Javadoc only gets me 10% of the way. And the developers quite frankly could and do do this on their own. My documentation goes deeper, into the functional relationships, who does what to whom, and why.

There is no software that will automatically do that.


Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East, June 4-5, Baltimore/Washington D.C. area. 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 for more resources and info.

Previous by Author: Re: A HAT for the Mac
Next by Author: Re: FrameMaker 6.0
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