Monday 15 March 2010

.net - C# XML comment tag: how to see it? -



.net - C# <example></example> XML comment tag: how to see it? -

i utilize microsoft visual studio 2012. when set code examples xml comments of c# classes/methods, wonder: how user references assemblies see code example?

i tried reference own assembly, , way found was: @ assembly.xml file. can settle visual studio or else see code examples?

here set comments:

/// <summary> /// method illustration /// </summary> /// <example> /// <code> /// // here code example. phone call method this: /// const int = 10; /// methodexample(a); /// </code> /// </example> public static void methodexample(int parameter) { }

here in intellisense:

here in object browser:

here in assembly.xml file:

what i'd get: see code examples in object browser , intellisense.

a number of xml comment tags appear in intellisense kid elements of other tags. these tags, known childcompletionlist tags, are: c, code, example, list, listheader, para, paramref, see , see also.

/// <summary> /// methodexample function all... /// <example> /// <code> /// <para/>// here code example. phone call method this: /// <para/>const int = 10; /// <para/>methodexample(a); /// </code> /// </example> /// </summary>

c# .net visual-studio-2012 intellisense objectbrowser

No comments:

Post a Comment