为什么我无法从 Intellisense 中看到我的 <example>s 和 <code>s？使用 C# 和 Visual Studio 2017-2019

Question

我目前正在使用 Visual Studio 2019 编写一个 WPF/C# 应用程序。编写新方法后，我决定添加一些示例以便更好地使用。但是我的示例不会出现在 Intellisense 弹出窗口中。

我试过以下代码：

        /// <summary>...</summary>
        /// <param name="path">...</param>
        /// <param name="action">...</param>
        /// <example>
        /// Use this method like this:
        /// <code>
        /// MyMethod("C:\someFile.txt", s => File.Copy(s, "C:\someFile (copy).txt"));
        /// </code>
        /// </example>
        public static void MyMethod(string path, Action<string> action)
        {
            // some code ...
        }

我希望我的示例显示在从另一个文件调用时弹出的 Intellisense 弹出窗口中。发生的只是摘要显示而没有我的示例..

Answer 1

这很简单 - 因为它很有效。并且从未像您预期的那样工作。

您的 XML 评论很好，但 Visual Studio 仅显示 <summary> 部分（class \ 方法或属性的简短描述）以便快速熟悉class \ 方法或属性你将要使用的。

XML 评论可以很大，几乎没有什么限制它的大小。想象一下，要向您显示大评论，工具提示应该是多大？

因此，如果您或其他开发人员使用 Visual Studio 并且带有 <summary> 的工具提示没有为您提供足够的信息 - 只需使用 F12 进行声明并阅读完整评论，或者您可以使用 ALT + F12

在当前部分显示声明

不确定，但我认为它可以是一些扩展，可以根据需要显示工具提示

为什么我无法从 Intellisense 中看到我的 <example>s 和 <code>s？使用 C# 和 Visual Studio 2017-2019

Why can't I see my <example>s and <code>s from Intellisense? using C# and Visual Studio 2017-2019

c#

documentation

visual-studio