开发者

C# Style XML Comments in Delphi 2010

does Delphi 2010 have C# Style XML comments that show up开发者_Go百科 when hovering over the method call?

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


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

You must have that HTML evaluation thingie enabled for this to work. See Options -> Editor options -> Code Insight -> Symbol description (translated fron a German IDE).


It does work - in Delphi 2007 and 2009 there are issues with it - you have to have a type keywork before every class, or it only picks out the first set of documentation (no idea why), and if you click the 'Build XML documentation' option, it seems to get lost when compiling lots of units and gives up - I hope this is fixed in Delphi 2010.

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

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


There is not much documentation available for this, although there is a small article on the Delphi Wiki. Marco Cantu also has a couple of short blog posts here and here.

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜