#c# #visual-studio #documentation
#c# #visual-studio #Документация
Вопрос:
В настоящее время я использую 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, которое появляется при вызове из другого файла.
Что происходит, так это просто сводка отображается без моих примеров..
Ответ №1:
Это просто — потому что это так работает. И никогда не работал так, как вы ожидали.
Ваши XML-комментарии в порядке, но Visual Studio показывает только <summary>
раздел (краткое описание класса метода или свойства) для быстрого ознакомления с классом методом или свойством, которые вы собираетесь использовать.
Комментарии XML могут быть очень большими, их размер практически ничто не ограничивает. Представьте, какого размера должна быть всплывающая подсказка, чтобы показать вам большие комментарии?
Поэтому, если вы или другой разработчик используете Visual Studio, а всплывающая подсказка с <summary>
не дает вам достаточно информации — просто перейдите к объявлению с F12
помощью и прочитайте полный комментарий ИЛИ вы можете показать объявление прямо в текущем разделе с помощью ALT F12
Не shure, но я думаю, что это могут быть некоторые расширения для отображения всплывающей подсказки, как вы хотите
Комментарии:
1. Тогда мне действительно нужно спросить этого парня, какую версию VS он использует… pluralsight.com/guides /…
2. Это работает в «VS Code», но не в VS? странно… О, и я не могу представить, что вы сказали о размерах всплывающих подсказок, не представляя, что разработчики устанавливают для этого ограничение на количество символов.. Спасибо за вашу помощь!
3. @Barina VS Code — это другая вселенная. Да, это странно, потому что оба они называются «Visual Studio», но они разные, как NotePad и MS World
4. да, я знаю.. Я всегда думал, что VS богаче возможностями, но на этот раз выигрывает VS Code. думаю, я просто засуну это в резюме 😉 что будет не очень красиво без форматирования, но это что-то