Using Descriptions as a Basis for Object Reference Documentation

When you develop new objects, it is good practice to enter a short description of the purpose of an object. This description is specified just like other properties by using Object Designer in the development environment.

The Description property on an object can be used internally between developers to communicate the purpose of the object, and it can also be used to form the basis for generating reference help. The Reference Help Generator tool can extract these object descriptions and use them in object reference Help as a starting point for a technical writer to document the object. If you regularly fill in the Description property as you develop objects, a generated reference Help project will never be empty.

For more information, see How to: Generate a New Help Project.

See Also

Other Resources

Help Generator Tool