Using Doc-O-Matic (Express) with Delphi

Question

I am looking for a tool to generate Delphi source code documentation, and I want to give a try to Doc-O-Matic Express (which is free). Are there any guidelines for beginners how to use Doc-O-Matic Express to document Delphi source code (managing doc-o-matic projects, preferred docblock style, complete docblock syntax, etc) ?

Answer 1

Don't bother with Doc-o-matic settings right now. The express edition is command-line only.

1. Choose a comment style
2. Comment your code
3. Generate documentation (a default project is enough to start)
4. Verify you comment coverage

Doc-o-matic support JavaDoc and XMLDoc (or even kind-of native comments). The tool it-self will help only if your code is already comment, or if you want to comment directly inside its IDE.

If you like XML Doc or JavaDoc, Doc-O-Matic does support both equally well and all three styles are supported when writing source comments through the integrated editor back to the source.

Answer 2

In this page you can found a doc which can be useful for you Delphi Documentation Guidelines. I used this guidelines to document my source code in this project.