Component Help

  • Article

For each component that you author, it is highly recommended that you write a component Help file with complete details of the component's functionality. This is in addition to the component description that is included in the common properties of a component. Fully documenting a component assists those who use it and also serves as the basis of a test plan.

Component Help is formatted with Hypertext Markup Language (HTML). The following list shows some of the information that can be included in the Help for a component:

  • Functionality description
  • Associated services and resources
  • Associated components
  • Expressed dependencies
  • Exposed interfaces
  • Configurable settings
  • Component interactions

See Also

Application and Device Driver Components | How to Componentize an Application | How to Componentize a Device Driver

Last updated on Wednesday, October 18, 2006

© 2006 Microsoft Corporation. All rights reserved.