C# 为自定义控件(或类)的方法属性添加注释
一、在Form的属性窗口中显示属性及属性说明[Description("容器分辨率"), Category("自定义")]public Size PanelSize{get { return _PanelSize; }set { _PanelSize = value; }}...
一、在Form的属性窗口中显示属性及属性说明
[Description("容器分辨率"), Category("自定义")]
public Size PanelSize
{
get { return _PanelSize; }
set { _PanelSize = value; }
}
其中的 [Description(“容器分辨率”), Category(“自定义”)]就是在属性窗口中添加属性及属性说明
主要标识符有:
Browsable
指定属性是否应该在属性窗口中显示,使用布尔值设置。一般情况下,对于常用的和比较重要的属性设置Browsable为true,否则,设置Browsable为false。
EditorBrowsable
设置属性在编辑器中的可见性,比如设置在智能提示列表不显示或高级用户才可以看到该属性。
Category
指定属性在属性浏览器中进行分组显示的类别。该设计时特性帮助可视化编辑器将属性进行逻辑分组。通常分为:外观(Appearance)、行为(Behavior)、布局(Layout)、数据(Data)、操作(Action)、键盘(Key)和鼠标(Mouse)等。如果您安装的是中文版的IDE,则默认情况下中文分类和英文分类是通用的,即设置成“数据”或“Data”类别是等价的。
Description
设置显示在属性窗口最下面的描述属性功能的文字说明。
二、添加xml注释(引用时鼠标停留在属性上时,显示注释内容)
/// <summary>
/// 容器分辨率
/// </summary>
[Description("容器分辨率"), Category("自定义")]
public Size PanelSize
{
get { return _PanelSize; }
set { _PanelSize = value; }
}
其中的
/// <summary>
/// 容器分辨率
/// </summary>
为XML注释说明。
但由于VS编译时默认不编译注释,所以还需要在项目-属性-生成-输出-XML文档文件,勾选上
[参考文档]
https://bbs.csdn.net/topics/120092251
https://bbs.csdn.net/topics/360070744
更多推荐
所有评论(0)