Re: Source Code Documentation Systems?

Subject: Re: Source Code Documentation Systems?
From: Dianne Blake <write-it -at- home -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 24 Jan 2001 11:43:45 -0800

David Price wrote:
>
> Javadoc is designed to document the API, which it does very well, provided
> that the Javadoc comments have been added to the source.

And that the comments are kept up-to-date. I've visited code that did
not match the comments many a time.

-Dianne Blake
Consultant, Writer and Trainer

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: Help for XML
Next by Author: Re: Break Into Telecommuting
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