120 Chapter 2
Agilent VEE Programming Techniques
Documenting Agilent VEE Programs
Documenting Agilent VEE Programs
By using the File ⇒ Save Documentation... command, you can
automatically generate program documentation. VEE lists all objects, with
key settings, the default and user names, the Description entries, and any
“nesting.” For example, objects within a
UserObject are nested one level
from the main VEE environment, and these levels are indicated by numbers.
You can also document individual objects using a Description. First, this
exercise describes how to document an individual object, and then how to
generate the program documentation.
Documenting Objects with Description Dialog Boxes
All objects have a Description item in their object menus, which
provides a dialog box to accept documentation on that particular object. This
documentation file also provides a way to correlate the documentation with
screen dumps. In this section, you will add an entry to the
Description
dialog box.
1. Open the
Random.vee program.
2. In the Main object menu, click
Description. Type text in the dialog
box as shown in Figure 2-35: Click
OK when you are done.