<example> </ example> XML注释标记:如何查看？

Question

我使用Microsoft Visual Studio 2012.当我将代码示例放入C#classes/methods的XML注释中时,我想知道:引用我的程序集的用户将如何看到该代码示例？

我试图引用自己的程序集,我找到的唯一方法是:查看assembly.xml文件.我可以解决Visual Studio或其他任何东西来查看这些代码示例吗？

以下是我对评论的评价:

/// <summary>
/// This is my method example
/// </summary>
/// <example>
/// <code>
/// // Here is my code example. Call my method like this:
/// const int a = 10;
/// MethodExample(a);
/// </code>
/// </example>
public static void MethodExample(int parameter)
{
}

这是我在intellisense中得到的:

这是我在对象浏览器中得到的:

这是我在assembly.xml文件中得到的:

我想得到的内容:请参阅对象浏览器和智能感知中的代码示例.

Answer 1

许多 XML 注释标记仅作为其他标记的子元素出现在 IntelliSense 中。这些标记称为 ChildCompletionList 标记，包括：c、code、example、list、listheader、para、paramref、see 和 see Also。

/// <summary>
/// MethodExample the function that does it all...
/// <example>
/// <code>
/// <para/>// Here is my code example. Call my method like this:
/// <para/>const int a = 10;
/// <para/>MethodExample(a);
/// </code>
/// </example>
/// </summary>