The following are some of the best practice rules to follow when creating an Application Definition. These rules make reading the Application Definition easier and also help if you need to make modifications in the future.
This section contains the following information:
Use capitalization where applicable.
Use comments throughout to explain what each section does and how it does it.
Switches are placed directly after the command, for example, Type -Raw, If -Text.
All variable names start with a capital letter.
Indent sections between pairs of commands, for example Dialog, Repeat, If.
An indent of three spaces is recommended.
Leave a blank line between sections, for example, between the Dialog Block and the rest of the Application Definition.
Table 4-8 Blank Line Between Sections
Write subroutine sections at the bottom of the Application Definition and not half way through.
The name of the subroutine should describe its function. Do not use a numeric name. The name should follow the capitalization rule.
Wherever possible, use the Include command to create generic Application Definitions for frequently used elements, for example password change procedures. For common processes within the same Application Definition, use Subroutines.
Always use quotation marks around segments of text in commands.
Password policy names should represent the program they are used for. Do not use numerical names.
At the top of the Application Definition enter and comment out information, for example, the author and the date of the last modification.
Table 4-11 Example
NOTE:Always place the Title command after all other commands in the Dialog block.