All geek questions in one place

What XML comment tags are supported in Object Explorer

I would like to provide a higher level of detail at the class level (in this case, actually Module ) with code samples, etc., but I am having problems working with various tags.

 ''' <summary> ''' Here a summary of <c>SmallCodeChunk</c> ''' </summary> ''' <example> ''' Mmm, Skynet? ''' <code> ''' code.CodingItself("that so meta!") ''' </code> ''' </example> ''' <remarks> ''' <para>Unit testable by replacing the <see cref="Implementation"/> property ''' with a mocked/stubbed <see cref="IThingy"/>. ''' </para> ''' <para>Paragraph of a bunch of stuff. <c>Y</c> is used for <c>True</c> just ''' for the sake of making the universe a (not) better place. ''' </para> ''' </remarks>

I understand that some of the tags used (e.g. <exception> ) are probably really invalid, but it seems to me that I can do things like <example> . And I would expect some kind of formatting (a monospace font, maybe?) For the <c> tags.

If I am not doing anything wrong, is there a subset of XML document tags that are supported for displaying objects in the browser?

+4
source share
2 answers

According to an article in MSDN Magazine 2009 :

The Object Browser displays summary , param , return , remarks , typeparam, and exception comments when they exist.

A 2006 MSDN blog post adds see and seealso to this list.

+5
source

The following is a list of recommended tags: http://msdn.microsoft.com/en-us/library/ms172653 (v = vs .80) .aspx

Shortly speaking:

 <c> <code> <example> <exception> * <include> * <list> <para> <param> * <paramref> <permission> * <remarks> <returns> <see> * <seealso> * <summary> <typeparam> * <value>

where '*' denotes tags for which the compiler checks the syntax. And here is a short article with some additional examples and examples:

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

+1
source

Source: https://habr.com/ru/post/1484709/

More articles:


All Articles