views:

1750

answers:

7

I need a code documentation tool similar to javadoc or c# xml doc for delphi code. What is the best tool? I prefer a technology, which is in the future compatible to the Microsoft sandcastle project.

+3  A: 

Delphi + JavaDoc = DelphiCodeToDoc

CMS
+3  A: 

As far as I'm aware, there is no tool easily compatible with Microsoft Sandcastle - at least until somebody actually bothers to write one, to modify an existing one, or to create a toolchain to properly transform the output.

I've personally used PasDoc with great success. I recommend building the latest SVN version, since the current release occasionally croaks on complicated interface definitions.

Mihai Limbășan
I also use PasDoc and run it from an Ant build script called by CruiseControl, FWIW.
Richard A
Richard, that's a good point since it shows it can be automated via a build.
Pauk
+3  A: 

Try: Doxygen, Pas2Dox

Drejc
I use it successfully in the past five or so years, still a great and simple solution.
mjustin
works great (and looks like the documentation for c and c++ project we also use)
sdu
+1  A: 

Sandcastle needs to get access to the assemblies in order to generate it's documentation, which means that it is only applicable for .net languages (although I'm not sure able Delphi.Net). However, Delphi 2007 and 2009 has an inline XML documentation very similar to C#. When you switch on the 'generate XML documentation' option in the project options, it will build XML documentation based on these comments. XSLT can then be used to generate whatever documentation format you need (this is the difficult bit).

+2  A: 

Since Delphi 2005 it is build in the Delphi compiler. It uses the XMLDoc standard which uses XML style comments. Just as C# does, so I guess Sandcastle can handle it. See http://dn.codegear.com/article/32770 and http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

Also see http://stackoverflow.com/questions/33336/documenting-delphi

Lars Truijens
The D2006 XMLDoc generator is completely broken. I tried to use it - does not work at after all patches.
Fabricio Araujo
A: 

DelphiCodeToDoc also have a command-line to use it with continuous integration tool (for example).

TridenT
A: 

try http://doc-o-matic.com/

GX