组件的用户支持

更新：2007 年 11 月

作为组件的创作者，您应该为用户提供关于组件的支持和文档。可以在设计时通过描述性元数据、在运行时通过调用 HTML 帮助来提供支持。

可以通过使用“属性”提供关于组件的描述性信息。属性是专用类，它们附加到其他类或类成员并在编译时发送到元数据中。属性可以将信息提供给用户或者直接提供给开发环境。例如，在将 System.ComponentModel.DescriptionAttribute 属性 (Attribute) 附加到属性 (Property) 或事件时，将在“属性”(Property) 窗口中显示一个简短的描述性字符串。其他属性影响开发环境对于组件的行为方式。例如，System.ComponentModel.BrowsableAttribute 属性 (Attribute) 确定属性 (Property) 是否出现在“属性”(Property) 窗口中。

组件通常不提供运行时支持，但在某些情况下提供它可能有意义。例如，非常大而且复杂的组件可能有内置的“帮助”，这样开发人员就不必编写广泛的文档。.NET Framework System.Windows.Forms.Help 类封装 HTML 帮助 1.x 引擎，并可用来在运行时通过 HTML 文件或 .chm 文件为用户提供帮助。有关详细信息，请参见 如何：为组件指定帮助文件。

本节内容

• 如何：为组件指定帮助文件
  解释如何在运行时为组件指定和显示帮助文件。

• 如何：提供关于组件的元数据说明
  说明如何为组件创建和附加标准描述性属性和自定义描述性属性。

• 如何：为组件的属性、方法和事件提供元数据
  描述如何为代码成员附加描述性属性。

相关章节

• 属性 (Attribute) 概述
  提供属性概述及其在 .NET Framework 中的用法。

• 扩展设计时支持
  提供指向一些主题的链接，这些主题介绍如何将组件和控件集成到设计环境中。

Topic	Location
如何：在 Windows 应用程序中提供帮助	Windows 窗体编程
帮助支持（针对 Visual Basic 6.0 用户）	Visual Basic 升级信息
如何：在 Windows 应用程序中提供帮助	Windows 窗体编程
如何：在 Windows 应用程序中提供帮助	Windows 窗体编程
帮助支持（针对 Visual Basic 6.0 用户）	Visual Basic 升级信息
如何：在 Windows 应用程序中提供帮助	dv_ManCli

请参见

参考

System.Windows.Forms.Help