TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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.
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
---
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.