Как добавить краткую информацию

Question

Я почти уверен, что это будет очень простой ответ, но я не могу найти его нигде. Мы все знаем, когда вы наводите указатель мыши на что-то (например, на строку), появляется небольшое резюме (если оно включено). Для строки написано:

класс System.String

Представляет текст в виде последовательности символов Юникода.

Когда я нащупываю один из моих классов, он просто говорит:

class Namespace.Widget

Я попробовал два очевидных примера, которые нашел:

/// <summary>
/// This summary does not work, I know it's for html documenting tools but thought it was worth a shot.
/// </summary>

и

// Summary:
//     This is what is in some of the base libraries, and does not work as well.

Итак, как мне добавить сводку во всплывающую подсказку?

Answer 1

Не понимаю, почему твоя первая попытка не сработала. Это тег комментария <summary>, который содержит «всплывающую подсказку», о которой вы говорите ...

/// <summary>
/// This text should automatically show up as the summary when hovering over
/// an instance of this class in VS
/// </summary>
public class MyClass
{
    public MyClass() {}      
}

public class MyClass2
{
    public MyClass()
    {
        //hovering over 'something' below in VS should provide the summary tooltip...
        MyClass something = new MyClass();
    }
}

Если вам нужна помощь в автоматизации некоторых ваших комментариев, попробуйте бесплатную GhostDoc . Безусловно один из лучших бесплатных VS дополнений ..

Answer 2

Трехслойные XML-комментарии можно использовать для создания подсказок IDE в Visual Studio. В частности, «резюме» и «исключение» работают очень хорошо. (Другие вещи, такие как «код», не работали в версиях Visual Studio, которые я использовал.)

Если это не работает для вас, значит, что-то не так с вашими настройками.

Answer 3

Вам необходимо использовать свой первый синтаксис, и, если вы используете класс вне вашего решения Visual Studio, вам нужно проверить файл Generate XML Documentation в Свойствах проекта.

Answer 4

Сброс настроек в visual studio, они, похоже, испорчены. И чтобы он появился, вам нужно использовать первый пример.