Cómo agregar un resumen del mouse-over

Question

Estoy casi seguro de que esta será una respuesta muy simple, pero parece que no puedo encontrarla en ningún lado. Todos sabemos que al pasar el mouse sobre algo (como una cadena) aparece un pequeño resumen (si está habilitado). Para una cadena, que dice:

System.String clase

Representa el texto como una serie de caracteres Unicode.

Cuando ratón sobre uno de mis clases, sino que simplemente dice:

clase Namespace.Widget

que he probado los dos ejemplos obvios que he encontrado:

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

y:

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

Entonces, ¿cómo agrego un resumen al menú emergente del mouse?

Answer 1

No veo por qué su primer intento no funcionaría. Es la etiqueta <summary> comentario que suministra el 'tooltip' que está hablando ...

/// <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(); 
    } 
} 

Si desea ayudar a automatizar algunos de sus comentarios, intente la libre GhostDoc. Con mucho, uno de los mejores complementos VS gratuitos.

Answer 2

Restablece tu configuración en Visual Studio, parece que están en mal estado. Y para que aparezca, deberías usar el primer ejemplo.

Answer 3

Los comentarios XML de tres barras se pueden usar para crear las sugerencias de herramientas IDE en Visual Studio. En particular, "resumen" y "excepción" funcionan muy bien. (Otras cosas como "código" no han funcionado en las versiones de Visual Studio que he utilizado).

Si esto no funciona para usted, puede que algo esté mal con sus configuraciones.

Answer 4

Debe usar su primera sintaxis y, si está utilizando la clase fuera de su solución de Visual Studio, debe marcar Generar archivo de documentación XML en Propiedades del proyecto.