Documenting your EXECs

Use the EXEC information line to classify EXECs by GROUP, FUNCTION, CODE, DESCRIPTION, DISPLAY, or AUTHOR. Then you can structure solutions or EXECs to automate your data center.

The EXEC information line is specified within each EXEC and has the following format:

/* DOC GROUP() FUNC() CODE() DESC() DISP() AUTHOR()*/

where

Field	Description
GROUP	designates the first hierarchical level in 1- to 8 alphanumeric characters
FUNC	designates the second hierarchical level in 1- to 8 alphanumeric characters
DESC	provides a minimal description of the EXEC's purpose in 1- to 25 alphanumeric characters
DISP	indicates whether the EXEC should appear in a formatted member list; Y or N
CODE	is a two-character user assigned code
AUTHOR	overrides the ISPF author statistic in 1- to 8-alphanumeric characters

When an EXEC has a /*DOC statement, the EXEC Management application displays the values specified in the EXEC Description display. The information line can be located anywhere in the EXEC. It can be split over any number of physical lines.

Documenting your EXECs

Comments