Как добавить обзор с помощью мыши

Question

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

класс System.String

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

Когда мышь над одним из моих классов, он просто говорит:

класс 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

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

Answer 3

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

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

Answer 4

Необходимо использовать свой первый синтаксис, и если вы используете этот класс вне решения Visual Studio, вам нужно проверить файл создания XML-документации в Project Properties.