2012-05-27 7 views
7

¿Es posible agregar xml-comments para set y obtener asssorsors que serán visibles en Object Browser (VS 2010)?comentarios de C# xml para propiedades/evaluadores

 /// <summary> 
     /// Something abot property. 
     /// </summary> 

     public bool IsSomething 
     { 
       // get description 

       get 
       { 
        return isSomething; 
       } 

       // set description 

       set 
       { 
        // do some work 
       } 
     } 
+0

Si realmente te gustaría añadir comentarios para obtener y establecer de forma independiente, siempre se puede poner en práctica el getter y establecer métodos usted mismo, luego ponga sus comentarios XML en los métodos getter y setter. –

+1

No tendría sentido la mayor parte del tiempo si pudiera. Las propiedades no deberían ser responsables de la lógica compleja. Si desea aplicar alguna lógica compleja, olvídese de las propiedades y escriba un método y agregue sus comentarios. Como no quiere hacer mucha lógica dentro de sus propiedades, no necesita comentarlas. –

+0

Utilizo propiedades para lógica que usan muy pocos recursos de CPU. Para lógica compleja (más uso de CPU) utilizo métodos. Pero solo pregunto ... algunas propiedades pueden tener una lógica como las restricciones que establecen el valor en 0..100 para byte, etc. – zgnilec

Respuesta

7

No, no puede establecer estos comentarios directamente en los accesos. Sin embargo, los comentarios sobre la propiedad pueden ser bastante completos, recibirá sugerencias de IntelliSense cuando empiece a escribirlos. Si ha extendido comentarios, es posible que desee poner el material extra en el apartado de observaciones del comentario:

/// <summary> 
    /// Something about property. 
    /// </summary> 
    /// <remarks> 
    /// Some extra remarks that won't show up in the property's intellisense later. 
    /// </remarks> 
3

No lo crea al menos no en esa ubicación. Simplemente agregaría la información dentro de otras etiquetas existentes como

/// <summary> 
/// Gets or sets the x. 
/// </summary> 
/// <value> 
/// The x. 
/// </value> 
/// <returns> this saves the world</returns> 
/// <remarks> when you set this the wolrd ends</remarks> 
Cuestiones relacionadas