7

I assume that XML and Delphi Documentation Guidelines are becoming the de-facto standard for source-code documenting comments. That is good. The bad thing is that I cannot find any Delphi documentation generator (free or commercial) that fully supports these standards (for example Doc-O-Matic Express does not support <list> tags).

The question is: what XML documentation standards and Delphi source code XMLDoc documentation generators are ready to use now?

kludg
  • 27,213
  • 5
  • 67
  • 118
  • It's good apart from the bit where humans have to read and write XML! – David Heffernan Feb 07 '11 at 20:37
  • 1
    @David: No, you quickly get accustomed to writing XML. It is something like writing Pascal :) – kludg Feb 08 '11 at 01:16
  • @Serg I have never got accustomed to writing XML. I suppose it is going to be easier for programmers to *get* it than for non-programmers. Personally I'm a huge fan of YAML. – David Heffernan Feb 08 '11 at 09:20
  • IMHO XML is for human quick inspection only. Not for writing. It is too verbose and hampers reading too much. But a simple editor can go a long way – Marco van de Voort Feb 08 '11 at 12:41
  • @Macro: I am talking about XMLDoc-style in-source documenting comments. I like to write them, and I don't want to use any WYSIWYG XML editor for it. I still think that currently Doc-O-Matic is the best choice to generate Delphi source code documentation, though I must say that my commitment to Doc-O-Matic "has cooled significantly" ;) – kludg Feb 08 '11 at 15:33
  • @Serg: Other than List tag support, doc-o-matic does what you want? – Warren P Feb 08 '11 at 19:11
  • @Warren: That depends on what you want. Sure doc-o-matic is the best documentation generator for Delphi sources, and you can use it, taking into account the list of supported XML tags (if you use XMLDoc style) – kludg Feb 08 '11 at 21:17

2 Answers2

4

(You are asking two questions. That's probably why you are getting no answers.)

On the tools front, take a look at these previously asked questions:

Community
  • 1
  • 1
Leonardo Herrera
  • 8,388
  • 5
  • 36
  • 66
  • -1. The question is single, and the above is not an answer to it. – kludg Feb 08 '11 at 01:13
  • Well, your phrasing is somewhat strange. I thought you were asking for XML documentation standards and delphi source code XMLDoc generators. In the second link I provided you can find a tool for DelphiCodeToDoc which may or may not help you. Anyways, you are welcome. – Leonardo Herrera Feb 08 '11 at 02:00
  • DelphiCodeToDoc does not support XML at all. – kludg Feb 08 '11 at 03:30
  • @Serg: It's open source. How hard would it be to add that to it? Not very hard, I bet. – Warren P Feb 08 '11 at 19:13
0

I would check these products:

  • doxygen
  • NDoc 3 (but maybe it requires access to .Net assemblies - then it will not work)
albert
  • 8,285
  • 3
  • 19
  • 32
mjn
  • 36,362
  • 28
  • 176
  • 378