c# - XML注释标签：怎么看？

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 and 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>

Answer 2

如果您在 IntelliSense 中没有看到 XML 注释，或者在您编辑它们后它们没有更新，请尝试：

1. 没有看到：确保所有内容都包含在<summary> 元素中。参考：https ://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags

2. 不更新：关闭并重新打开解决方案（这似乎非常一致）

VS 耳鼻喉科 2019 (16.10.4)