DelphiDoc - makes it easier to document your software

Thourough documentation of software is seldom made. Some people will still say:
  If it was hard to write, it should be hard to read.

In order to change this way of thinking and making it easier for programmers to document their work, there need to be a simple and fast way of doing it. At SoftConsult we have allways pointed out that the right place to document software is in the source code. We have found an ultimate tool to do it when working with Java: the javadoc from Sun.
But we asked our selves: why does Borland not have a similar tool for Delphi?

And that is the reason why we decided to take some of our spare time and make a Delphi document generator similar to javadoc.
Our intention is that it should support the same tags as in javadoc and have a similar layout on the generated HTML pages. Since our spare time is limited, currently DelphiDoc is not supporting all javadoc tags but we are working on it.

Supported tags:

@deprecated - deprecated-text
Adds a comment that this method should no longer be used.

@param - parameter-name description
Adds a parametercomment

@return - decription
Adds return description from functions

@see - reference
Adds "Se Also" text, currently some supporting links as javadoc do

DelphiDoc can accept comments both in the declaration section and the implementation section. If you put comments in the declaration section this comments will be used in the list of methods and propertys. And those comments that you put in the implementation section will be used in the extended list of methods and propertys. If you only put comments in implementation section this will also be used in the list of methods.

Example of comment tag in code:

{** @deprecated "Now replaced by OpenTables2"
    Open all tables that is marked for opening

    @param  fastOpen    Use the fast opening routine
    @return             Returns true if Ok
    @see                OpenTables2}
function TfrmParentForm.OpenTables(fastOpen: boolean): boolean;
begin ...... ...... end;

will generate something like this:

function OpenTables(fastOpen: boolean); virtual;
Deprecated "Now replaced by OpenTables2"
Open all tables that is marked for opening
Parameters
   fastOpen :Use the fast opening routine
Returns
   Returns true if Ok
See Also
   OpenTables2
 

If you think this seems Ok the DOWNLOAD DelphiDoc now! If you also like mail notification of new versions please join our mailinglist.