This is for source code documentation, i.e. the audience is other programmers, not end-users.
At 08:55 AM 11/9/2005, Ken Crane wrote: >No it doesn't. >Don't forget that a help file typically giving detailed instructions to a >user or an overview may not be the kind of notes you want in your program. >Talking two different animals here. >----- Original Message ----- >From: "Sid Gudes" <[EMAIL PROTECTED]> >To: "Delphi-Talk Discussion List" <[email protected]> >Sent: Wednesday, November 09, 2005 10:50 AM >Subject: Re: Source Code Documentation Tools > > > > At 06:48 AM 11/9/2005, Ken Crane wrote: > >>If you really mean source code then it is down to you entering comments > >>against each line or section of code. No tool can do this for you. If you > >>are talking about a help manual, one that is available through the F1 key > >>then we use HelpScribble which we have found to be easy to use and adds > >>greatly to the professional image of the program. > > > > Of course the author of the source code needs to write the > > comments/documentation for each method, module, etc. However there > > is a maintenance problem if your documentation is in a help file and > > you modify a method. When you do the modification, it's really easy > > to update the comments that are inline, but then you have to go and > > modify the help file as well. Not only double work, but > > co-ordinating the help file among multiple developers can be a pain. > > > > There are several tools that will, if you write your inline comments > > in a certain way, scan the source code for you, extract the inline > > comments, and create a help file from them. This allows for easy > > generation of a help file. That's the type of tool that we're looking > > for. > > > > I was just requesting any feedback from the list on their experiences > > with this type of tool. My apologies if my original posting was > > vague. In any case, from what I saw on HelpScribble's web site, I > > don't think it does this. > > > > > >>----- Original Message ----- > >>From: "Francois PIETTE" <[EMAIL PROTECTED]> > >>To: "Delphi-Talk Discussion List" <[email protected]> > >>Sent: Tuesday, November 08, 2005 3:11 PM > >>Subject: Re: Source Code Documentation Tools > >> > >> > >> >> We're looking at acquiring a source code documentation tool to help > >> >> keep our documentation up to date. There seem to be quite a few on > >> >> the market. Anyone have recommendations, suggestions, good/bad > >> >> experiences? Thanks. > >> > > >> > HelpScribble is not bad : http://www.helpscribble.com/ > >> > > >> > Contribute to the SSL Effort. Visit http://www.overbyte.be/eng/ssl.html > >> > -- > >> > [EMAIL PROTECTED] > >> > The author for the freeware multi-tier middleware MidWare > >> > The author of the freeware Internet Component Suite (ICS) > >> > http://www.overbyte.be > >> > > >> > > >> > > >> > __________________________________________________ > >> > Delphi-Talk mailing list -> [email protected] > >> > http://www.elists.org/mailman/listinfo/delphi-talk > >> > >>__________________________________________________ > >>Delphi-Talk mailing list -> [email protected] > >>http://www.elists.org/mailman/listinfo/delphi-talk > > > > Regards, > > Sid Gudes > > PIA Systems Corporation > > [EMAIL PROTECTED] > > > > > > __________________________________________________ > > Delphi-Talk mailing list -> [email protected] > > http://www.elists.org/mailman/listinfo/delphi-talk > >__________________________________________________ >Delphi-Talk mailing list -> [email protected] >http://www.elists.org/mailman/listinfo/delphi-talk Regards, Sid Gudes PIA Systems Corporation [EMAIL PROTECTED] __________________________________________________ Delphi-Talk mailing list -> [email protected] http://www.elists.org/mailman/listinfo/delphi-talk
