.net - 对象浏览器支持哪些 XML 注释标签

Question

我想在类级别(在这种情况下实际上是 Module )和代码示例等提供更高级别的详细信息，但是我无法让各种标签工作。

''' <summary>
''' Here's a summary of <c>SmallCodeChunk</c>
''' </summary>
''' <example>
'''   Mmm, Skynet?
'''   <code>
'''      code.CodingItself("that's 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>

我意识到使用的一些标签(如 <exception> )可能不是真的有效，但似乎我应该能够做类似 <example> 的事情。 .我希望 <c> 有某种格式(可能是等宽字体？)标签。

如果我没有做错任何事，是否有支持在对象浏览器中显示的 XML 文档标签的子集？

Answer 1

根据 a 2009 article in MSDN Magazine :

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

A 2006 post on the MSDN Blogs将 see 和 seealso 添加到该列表中。