next up previous contents
Next: Example 1: ATESS Routine Up: A.1 Documenting Conventions Previous: Introduction Keywords:

Prologue Keywords:

Keyword Meaning
!MODULE: Module name
!ROUTINE: Routine/function name
!IROUTINE: Module-internal routine name
!DESCRIPTION: Routine/module description
!INTERFACE: Routine interface
!USES: Modules used
!DEFINED PARAMETERS: Constants
!INPUT PARAMETERS: Input arguments
!INPUT/OUTPUT PARAMETERS: Input/output arguments
!OUTPUT PARAMETERS: Output arguments
!PUBLIC TYPES: Types for export
!PUBLIC MEMBER FUNCTIONS: Functions for export
!PUBLIC DATA MEMBERS: Data members for export
!SEE ALSO: Other routines of interest
!FILES USED: Files accessed by routine
!REVISION HISTORY: Revision history
!LOCAL VARIABLES: Local variables
!SYSTEM ROUTINES: System routines
!BUGS: Known bugs
!REMARKS: Remarks
!TO DO: To do list
 

These keywords are suited to the needs of the DAO and the list (see table A.1) can be extended with minimal changes to the ProTeX script.


next up previous contents
Next: Example 1: ATESS Routine Up: A.1 Documenting Conventions Previous: Introduction Keywords:

Will Sawyer
Fri Mar 6 18:02:18 EST 1998