Unit descriptor

Edit online

A unit descriptor gives the name of the module, and the names of the component and product containing the module. Unit descriptors are not required in your code, but are recommended to provide Component and Product classifications for the LOC report.

A unit descriptor has one of the following formats depending on whether the source is a module, segment, or macro:

        $MOD(unitname) COMP(component) PROD(product) :  comment
        $SEG(unitname) COMP(component) PROD(product) :  comment
        $MAC(unitname) COMP(component) PROD(product) :  comment

If present, the unit descriptor must be the first item on any line of a block comment. Furthermore, there should not be more than one unit descriptor in a source file. If more than one is found, only the first one is used. A unit descriptor cannot be split over several lines.

Unit, component, and product names are enclosed in parentheses and can consist of any character other than the closing parenthesis. The maximum size of each of these names is eight characters.

The keywords may be separated by either a space or a comma.

The following example describes a unit descriptor for the unit ADDPROC, which is a module. It belongs to the component SC123, which is part of the product XYZ:

Figure 1. Sample unit descriptor

      $MOD(ADDPROC) COMP(SC123) PROD(XYZ): Add Procs to Test File