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?

7
  • It's good apart from the bit where humans have to read and write XML! Commented Feb 7, 2011 at 20:37
  • 1
    @David: No, you quickly get accustomed to writing XML. It is something like writing Pascal :) Commented Feb 8, 2011 at 1: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. Commented Feb 8, 2011 at 9: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 Commented Feb 8, 2011 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" ;) Commented Feb 8, 2011 at 15:33

2 Answers 2

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:

Sign up to request clarification or add additional context in comments.

4 Comments

-1. The question is single, and the above is not an answer to it.
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.
DelphiCodeToDoc does not support XML at all.
@Serg: It's open source. How hard would it be to add that to it? Not very hard, I bet.
0

I would check these products:

  • doxygen
  • NDoc 3 (but maybe it requires access to .Net assemblies - then it will not work)

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.