Re: Software that retrieves developer comments from code

[Brad Jensen <brad -at- elstore -dot- com>]

----- Original Message -----
From: "Sandy Harris" <pashley -at- storm -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Saturday, March 30, 2002 3:18 PM
Subject: Re: Software that retrieves developer comments from code
> 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.


Most comments won't exist in object code (what actually runs on
the computer.)

If you are going to extract them from source code, most of them
won't make much sense without the objects that they reference.

And since many of them will relate to algorithms, which are
generally considered trade secrets, you don't want them in public
anyways. Otherwise you lose non-compete and trade secret
protextions.

Brad Jensen
www.eufrates.com


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