C#为自定义控件添加说明

当我们自定义一个控件时,新的属性就需要我们自己去添加说明,如果不添加说明,时间久了,我们都不知道这个属性是干嘛用的,其他人就更不用说了.

[Description("在这里面填上你要的说明"), Category("自定义控件属性的Name")]

例如某控件Text属性:

[Description("与控件关联的文本"), Category("Text")]

注释标记:

/// <summary>
/// TestClass DoWork方法的类
/// </summary>
/// <para>第二个段落描述.
/// <see cref="System.Console.WriteLine(System.String)"/>
///  语句信息.
/// </para>

// 构造函数或方法时,应该添加注释标记,这样我们就知道这个函数/方法是干嘛的,而不是让人看了干瞪眼.

#region 设置提示框的背景
/// <summary> - 设置/获取 提示文本显示的 前景色 </summary>
private Color _lstForColor = System.Drawing.SystemColors.InfoText;
/// <summary> - 设置/获取 提示的 背景色 </summary>
private Color _lstBackColor = System.Drawing.SystemColors.InfoText;

/// <summary>设置/获取提示文本显示的前景色</summary>
public Color PromptForeColor
{
get
{
return _lstForColor;
}
set
{
_lstForColor = value;
ListBox box = this.lstPrompt;
if (box != null)
box.BackColor = _lstForColor;
}
}

/// <summary>
/// 设置/获取提示的背景色
/// </summary>
public Color PromptBackColor
{
get
{
return _lstBackColor;
}
set
{
_lstBackColor = value;
ListBox box = this.lstPrompt;
if (box != null)
box.BackColor = _lstBackColor;
}
}
#endregion

// 注释标记与属性说明:

/// <summary>设置/获取提示文本显示的前景色</summary>
[Description("设置/获取提示文本显示的前景色"), Category("PromptForeColor")]
public Color PromptForeColor
{
get
{
return _lstForColor;
}
set
{
_lstForColor = value;
ListBox box = this.lstPrompt;
if (box != null)
box.BackColor = _lstForColor;
}
}