Почему я не вижу свои <example>s и <code>s от Intellisense? с использованием 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> (краткое описание класса \ метода или свойства) для быстрого ознакомления с классом \ методом или свойством, которое вы собираетесь использовать.

* 1005XML-комментарии могут быть очень большими, буквально ничто не ограничивает их размер.Представляете, какого размера должна быть подсказка, чтобы показывать вам большие комментарии?

Так что, если вы или другой разработчик используете Visual Studio и всплывающая подсказка с <summary> не дает вам достаточно информации - просто перейдите к декорации с F12 и прочитайте полный комментарий ИЛИ вы можете показать объявление прямо в текущем разделес ALT + F12

Не уверен, но я думаю, что это может быть несколько расширений для отображения всплывающей подсказки, как вы хотите