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:<gdwarner -at- mindspring -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sat, 30 Mar 2002 04:56:31 -0500
"Cara O Sullivan"
<cara_osullivan -at- modusmedia -dot- com> wrote:
(*snip*)
> Is there a software package out there that
can retrieve developer comments
> from code and does it easily and cleanly?
Our developers provide in-house
> customizions of Peoplesoft (previously
known as Vantive) and IFS vendor
> software.
People have already suggested Doxygen ...
but if there are budget problems, perhaps a
cheaper solution is in order --!
You could have one of your VB programmers
write a little application that searches a text file
(the code -- and make sure it's a copy) for the
starting and ending character of a quote ("/*"
and "*/" in C, C++ and JavaScript, "//" in C,
Objective C and C++, etc.), puts each one into
a variable, writes the contents of the variable
into a window, clears the variable, and loops
through the process untill all the comments
have been processed.
Ideally, each end of a multi-line quote would
include a carriage return and a linefeed (say
"return") for spacing between comments.
You'll also need a way to tell where in the code
this occurs ... so if there are line numbers,
you'll need those too.
You might even be able to do this in Word
(Tools --> Macros --> Visual Basic Editor).
Good luck ....
--gdw
(*snip*)
> Cara O'Sullivan
> Documentation Writer
"We utilized a copper-based circular binary
random number generator to determine which
chip would best suit our needs."
(Translation: "We flipped a coin.")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
