5

我想在类级别（在这种情况下实际上是 a 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 文档标签支持在对象浏览器中显示？

4

2 回答 2

6

根据MSDN 杂志 2009 年的一篇文章：

对象浏览器显示summary、param、return、remarks、typeparam和exception注释（如果存在）。

2006 年 MSDN 博客上的一篇文章将see和添加seealso到该列表中。

于 2013-06-21T16:34:04.540 回答
3

以下是要使用的“推荐”标签列表：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

于 2013-06-14T18:55:20.683 回答