ISOCAM Interactive Analysis User's Manual Version 5.0 - ISO - ESA

324 APPENDIX D. GUIDELINES FOR WRITING CIA ROUTINES
D.3 How to write a header
In order for automatic formatting programs to work, as well as for purposes of standardisation,
these rules must be followed in all headers.
• A header begins with ;+ and ends with ;-
• There is only one header per file, regardless of the number of routines contained therein.
It may be anywhere in the file, but most programmers prefer to find it at the top.
• The keywords are:
; NAME:
; PURPOSE:
; CATEGORY:
; CALLING SEQUENCE:
; INPUT:
; OPTIONAL INPUT:
; KEYED INPUT:
; KEYED OUTPUT:
; OUTPUT:
; OPTIONAL OUTPUT:
; EXAMPLE:
; ALGORITHM:
; DEPENDENCIES:
; COMMON BLOCK:
; SIDE EFFECT:
; RESTRICTION:
; CALLED PROCEDURE:
; SEE ALSO:
; MODIFICATION HISTORY:
Note that the space and the upper case are compulsory, but you can add extra characters,
i.e. ; KEYED INPUTs: is correct, but not ; KEYED Input:
• The field of the keyword ; CATEGORY: is defined in the file category.txt. Thisfilecanbe
found in the document directory of the CIA distribution. The ; CATEGORY: field should
also specify whether the routine is ‘User’ or ‘Internal’, for example:
; CATEGORY: III-2 User
• The compulsory keywords are:
; NAME:
; PURPOSE:
; CALLING SEQUENCE:
; INPUT:
; OUTPUT:
; EXAMPLE:
; MODIFICATION HISTORY: