C # Style XML Comments in Delphi 2010

Question

Are there any C # XML comments in Delphi 2010 that appear when a method call hangs?

/// <summary> /// My comment here /// </summary> 

Answer 1

I just tried this in D2007 and it works. I put your test comment above the method declaration (inside the class declaration) and rebuilt. When you now hover over the call to this method, you will see "My comment here" inside the tooltip.

You must have the HTML evaluation feature enabled. See Options → Editor Options → Code Insight → Character Description (translated from German IDE).

Answer 2

This works - in Delphi 2007 and 2009 there are problems with this - you must have a keywork type in front of each class or it selects only the first set of documentation (I don’t know why), and if you click "Build XML documentation", it seems to be lost when compiling many units and gave up - I hope this is fixed in Delphi 2010.

Having said that the inline documentation is better than no documentation at all!

This link to Embarcadero is the only thing I can find, although I think there are Delphi utilities in the Architect and Enterprise versions for creating external documentation.

Answer 3

There is not enough documentation for this, although there is a small article in the Delphi Wiki. Marco Cantu also has some short blog posts here and here .