2012-05-27 19 views
7

È possibile aggiungere commenti xml per set e ottenere asss che saranno visibili in Object Browser (VS 2010)?C# xml commenti per proprietà/assessori

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

     public bool IsSomething 
     { 
       // get description 

       get 
       { 
        return isSomething; 
       } 

       // set description 

       set 
       { 
        // do some work 
       } 
     } 
+0

Se vuoi davvero aggiungere commenti per ottenere e impostare in modo indipendente, si può sempre attuare il getter e metodi setter da soli, quindi metti i tuoi commenti XML sui metodi getter e setter. –

+1

Sarebbe inutile la maggior parte del tempo, se potessi. Le proprietà non dovrebbero essere responsabili della logica complessa. Se vuoi applicare una logica complessa, dimentica le proprietà e scrivi un metodo e aggiungi i tuoi commenti. Dal momento che non vuoi fare molta logica all'interno delle tue proprietà non hai bisogno di commentarle. –

+0

Uso proprietà per la logica che utilizzano pochissime risorse della cpu. Per logica complessa (più utilizzo della CPU) utilizzo metodi. Ma mi chiedo solo ... alcune proprietà possono avere vincoli logici come valore impostato a 0..100 per byte, ecc. – zgnilec

risposta

7

No, non è possibile impostare questi commenti direttamente sugli accessori. I commenti sulla proprietà tuttavia possono essere abbastanza completi, riceverai suggerimenti intellisensi quando inizi a digitarli. Se è stato esteso commenti, si potrebbe desiderare di mettere la roba in più nella sezione commenti del commento:

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

Non pensare così almeno non in quella posizione. Vorrei solo aggiungere le informazioni all'interno di altri tag esistenti come

/// <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>