[RESOLVED] Q regarding documenting
Hi, I'm attempting to make use of the commenting facility in C# and I have a question that strangely enough I can't figure out for myself.
The following comments belonging to a property will display in intellisense just fine, but what tags should I use to make my description appear below the propertygrid as well?
Code:
/// <summary>
/// Gets or sets second color of the focus state gradient.
/// </summary>
public Color GradientFocusColor2
{
get {return msettings.GradientFocusColor2 ;}
set {msettings.GradientFocusColor2 = value;CreateGradientBrushes();this.Invalidate();}
}
Thanks for wasting your time on this :D
Re: Q regarding documenting
You need to use the DescriptionAttribute, like so:
Code:
/// <summary>
/// Gets or sets second color of the focus state gradient.
/// </summary>
[DescriptionAttribute("Gets or sets second color of the focus state gradient.")]
public Color GradientFocusColor2
{
get {return msettings.GradientFocusColor2 ;}
set {msettings.GradientFocusColor2 = value;CreateGradientBrushes();this.Invalidate();}
}
Re: Q regarding documenting