c# - XML 注释标记 : how to see it?

Question

我使用 Microsoft Visual Studio 2012。当我将代码示例放入 C# 类/方法的 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 文件中得到的内容:

我想得到的:在对象浏览器和 IntelliSense 中查看代码示例。

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>