2012-05-27 3 views
7

Можно ли добавить xml-комментарии для set и get asssessors, которые будут видны в Object Browser (VS 2010)?C# xml комментарии для свойств/оценщиков

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

     public bool IsSomething 
     { 
       // get description 

       get 
       { 
        return isSomething; 
       } 

       // set description 

       set 
       { 
        // do some work 
       } 
     } 
+0

Если вы действительно хотите добавить комментарии для получения и установки самостоятельно, вы всегда можете реализовать сорбент и setter methods, а затем поместите свои комментарии XML в методы getter и setter. –

+1

Было бы бессмысленно большую часть времени, если бы вы могли. Свойства не должны отвечать за сложную логику. Если вы хотите применить некоторую сложную логику, забудьте о свойствах и напишите метод и добавьте свои комментарии. Поскольку вы не хотите делать много логики внутри своих свойств, вам не нужно их комментировать. –

+0

Я использую свойства для логики, которые используют очень мало ресурсов процессора. Для сложной логики (больше использования процессора) я использую методы. Но я просто спрашиваю ... у некоторых свойств может быть логика, такая как ограничение установленного значения до 0..100 для байта и т. Д. – zgnilec

ответ

7

Нет, вы не можете устанавливать эти комментарии непосредственно у аксессуаров. Однако комментарии к собственности могут быть довольно полными, вы получите предложения intellisense, когда начнете их печатать. Если вы продлили комментарии, вы можете поставить дополнительный материал в раздел примечаний комментария:

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

Не думайте так, по крайней мере, не в этом месте. Я бы просто добавил информацию внутри других существующих тегов, например,

/// <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> 
Смежные вопросы