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：

对象浏览器显示摘要， param ，返回，备注， typeparam ，以及 exception 注释。

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

Answer 2

以下是要使用的“推荐”代码列表：http://msdn.microsoft.com/en-us/library/ms172653(v=vs.80).aspx

简而言之，他们是：

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

其中'*'表示编译器验证语法的标记。这里有一篇简短的文章，其中包含一些额外的方法和例子：

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

对象浏览器支持哪些XML注释标记

2 个答案: