Re: Which documentation tool (DelphiDoc or Doc-o-Matic)

Jim Davis wrote:
- If you comment within the body of the source code, these will not be extracted (regardless of tag prefix)

This has been getting thoughts in the past and while it is a rather simple thing to add, it won't work most of the time. The basic question is if you had an option like this, how would like like it to work? If you have a function body that contains one comment only, things are pretty simple. But what if you have a body with comments all over the place, commenting individual blocks of instructions. Concatenating them together most likely doesn't produce a meaningful result.

We decided that if it's important to see the body comments, they must be shown in context of the source code. And that you can do.

- If you opt to have the source code itself included in the documentation, all comments within the source code body are then also included in the documentation (regardless of tag prefix), and cannot be hidden.

While this is not possible with v5 it will be with the next major release.

Regards
Markus
--
______________________________________________________________________
Markus Spoettl,
toolsfactory software
http://www.doc-o-matic.com
.

Relevant Pages

  • Re: Exception Handling - help!
    ... > Send me a link to your manifesto; ... have to check the source code to try to distinguish between an OS behavior ... important that the .net behavior be logically consistent and that it does ... the "right thing" regardless of the underlying OS. ...
    (microsoft.public.dotnet.framework.clr)
  • Re: Which documentation tool (DelphiDoc or Doc-o-Matic)
    ... few basic omissions that were show stoppers for our organization were: ... If you opt to have the source code itself included in the documentation, ... documentation (regardless of tag prefix), ...
    (borland.public.delphi.thirdpartytools.general)
  • Re: microsoft.public.pocketpc, microsoft.public.windowsce.app.development, microsoft.public.pocketpc
    ... Regardless, back to my original problems, I was wondering if they ... question of why the same source code builds to a different file size ... depending on whether it's targeted toward 2002 or 2003 devices. ...
    (microsoft.public.pocketpc)
  • Re: Clicking on links in this group?
    ... I would say you should look at the context. ... But regardless most ... I was searching for some (developer) source code for a very specific ...
    (alt.sys.pc-clone.dell)
  • Re: DGNews version 2.1 SQL Injection Vulnerability
    ... read the database credentials plain text: ... //information is in the source code. ... works regardless of php.ini settings. ...
    (Bugtraq)