Saturday, October 23, 2004

JavaDoc

Hey, I am becoming a true developer...
I was amazed to discover an open source tool for delphi
that has the equivalent functionallity of JavaDoc.
It's called DelphiCodeToDoc, and you can download it here.

For those of you who don't know (or don't care) what JavaDoc is, it's a tool for creating source code documentation out of its comments. Trully usefull to get an overview of a project someone else made...

So, I made a couple of code templates, for easy insertion of comments into my projects. Here's an extract of my delphi .dci file, in case you want to use them yourself:

[rem | Method Header | Borland.EditOptions.Pascal]
{*-----------------------------------------------
  simple method description
  @param
  @return
-------------------------------------------------}

[header | Unit Header | Borland.EditOptions.Pascal]
{*-----------------------------------------------
  simple unit header
  unit details

  @author
  @version

  Copyright (c) 2004, Space Invader Software
-------------------------------------------------}