Once a Nucleus application reaches a certain number of components, it can be difficult to tell what each individual component does. Documenting your components reduces this problem. You can document your components using the $description
property. For instance, you could describe a Person
component like this:
$description=Holds name and age traits of users
You can set a component’s $description
property in the Basics tab of the Component Editor. Enter the description in the Description field. The Components window displays the value of the $description
property of the active component in the info window, along with the component’s path, class name, and scope.