1. Computing

Delphi Code to Doc

Free documentation tool for Delphi, with JavaDoc support.

By

DelphiCodeToDoc

DelphiCodeToDoc Screen Shot

Want to work with JavaDoc and Delphi ? it is now possible, for free and with source !

What is DelphiCodeToDoc?

DelphiCodeToDoc is a free documentation system for Delphi.
It uses information about source code symbols and formatted comments in files to produce accurate documentation from your aplication and component.

This documentation support TEXT file based and HTML style, but will be extend to CHM, PDF, and furthermore other format. DelphiCodeToDoc makes sure the structure of your documentation always stays synchronized with your code. It support JavaDoc style comments, in-line comments, and is open for other "tags based" styles. You can configure DelphiCodeTodoc to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various source code elements. DelphiCodeTodoc is developed under MS-Windows with Borland Delphi, but will be setup to be portable for Kylix under Linux. It use JCL and JVCL library from Jedi Project

FAQ

This section will try to answer some common asked questions, so read it before submitting a support request or asking help by mail, thanks.

What will DelphiCodeToDoc do for me ?
It will generate an accurate documentation of your source code, and very important, it will be always up-to-date. It can be your source - if you want other to understand your software, or write a technical specification for your component and/or library - or a third party source, and you will quickly understand the software architecture and the relations between units, classes and all elements of the code.

What does it need?
You need a Delphi (Pascal object style) source code, with formatted comment. This last point is not a requierement, but highly recommended.

What is JavaDoc and other TAGs commented systems?
For this point, please see the Supported TAGs systems page.

How do I configure the application ?
Have a look to the Project's configuration page. It explains all the options and how to work with them.

Why should I write comments in my source code?
First, you need to comment your source code for you, and others if you share your source. It helps understanding what you have done, and how. Units, classes and members description (with TAGs) will give a overview of their role in the application. Make a modification on an older part of the code is easier if the code was commented, specially if your are not the creator of the source.
Second, comments will help you to architecture your application. If you have difficulties or can't explain what you just write (or better what you are going to code), it's time to review your system!

Is it really free?
Yes of course. The application and the source code are free, see the GNU GPL page to understand the licence details.

Download DelphiCodeToDoc

The latest version is always available from the main DelphiCodeToDoc web site.

©2014 About.com. All rights reserved.