Añadir una descripción para una propiedad

Question

¿Cómo agrego una descripción de texto para mi propiedad?

Mi código:

private bool _SpaceKey; 

public bool SpaceKey 
{ 
    get 
    { 
     return _SpaceKey; 
    } 
    set 
    { 
     _SpaceKey = value; 
    } 
} 

Answer 1

Tener un vistazo a la Description Attribute:

[Description("This is the description for SpaceKey")] 
public bool SpaceKey { get; set; } 

Puede, además, utilizar la Category Attribute para especificar la categoría de la propiedad:

[Category("Misc")] 
[Description("This is the description for SpaceKey")] 
public bool SpaceKey { get; set; } 

Answer 2

Si desea ver la descripción en el diseñador de Visual Studio (o cualquier otro IDE compatible), deberá usar design-time attributes for components que están definidos en el espacio de nombres System.ComponentModel.

[Description("This is the description of Space Key.")] 
public bool SpaceKey { get; set; } 

Antes de hacerlo, considere aprender cómo escribir una buena descripción de las descripciones en la biblioteca de clases (aunque no siempre son útiles, tampoco). Es bueno seguir el estilo existente.

Si quieres ver consejos en código, al igual que información sobre herramientas cuando se selecciona un miembro con IntelliSense, es necesario también utilizar para la documentación XML comments:

/// <summary> 
/// Gets or sets space key (that would probably make a bad summary). 
/// </summary> 
public bool SpaceKey { get; set; } 

Eso es todo.

Answer 3

(un poco tarde, pero tal vez útil a alguien)

Otra opción que se puede utilizar es:

[Browsable(true)] 

Si el Browsable es true, se puede ver la propiedad en la ventana de propiedades y cuando su false, nadie podría cambiarlo a través de la ventana de propiedades en el diseñador. Ver more information sobre eso.