Re: Software that retrieves developer comments from code

Subject: Re: Software that retrieves developer comments from code
From: dmbrown -at- brown-inc -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 30 Mar 2002 17:07:04 -0800


Sandy Harris wrote:
>
> You probably don't want all the comments. Some
> are needed only by a programmer who is working
> on the code and (at least arguably) don't belong
> in the documentation. That needs only the comments
> directed at users of the code.
>
> If that is correct, the easiest method is to pick
> some special format for extractable comments.

This is the principle behind JavaDoc, the standard for extracting documentation out of Java source files.

The JavaDoc "generator" produces a multiframed HTML document that automatically contains cross-references and other useful navigation mechanisms. The result is far from beautiful, but it is an industry standard for Java API documentation.

Read all about it here:

http://java.sun.com/j2se/javadoc/

--David

=============================
David M. Brown - Brown Inc.
dmbrown -at- brown-inc -dot- com
=============================

A V A I L A B L E N O W ! http://www.html-indexer.com/

HTML Indexer 4, still the easiest way to create and maintain real indexes
for web sites, intranets, HTML Help, JavaHelp, and other HTML documents.

Now including integrated cross-references, targets, frames, and much more!

 

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at
http://www.ehelp.com/techwr

Check out the TECHWR-L Site redesign!
http://www.raycomm.com/techwhirl/

---
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.


References:
Re: Software that retrieves developer comments from code: From: gdwarner
Re: Software that retrieves developer comments from code: From: Sandy Harris

Previous by Author: Re: Stand-up presentations
Next by Author: Re: Word 97 Index -> HTML
Previous by Thread: Re: Software that retrieves developer comments from code
Next by Thread: Re: Software that retrieves developer comments from code


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

Sponsored Ads


Sponsored Ads