COMMON documentation

In every Historian COMDECK there shall be only one COMMON statement. The COMMON name and the COMDECK name shall be the same. An exception is allowed if variables of different type (character and other) belong logically together. Dimensions of common-variables shall be given as parameters. If these are not used elsewhere, the parameter statement may be put into the same COMDECK. COMMON variables shall be dimensioned in the COMMON declaration and not in an extra DIMENSION or type declaration statement.

A general comment for the comdeck shall be given in the first three lines of the documentation part of the COMDECK which starts with '*IF DOC'. The documentation lines start with 'C', 'C!' or just two blanks. Every COMMON- variable or PARAMETER is described in at least one line giving the variable name, a separator (which can be '=',':' or blank) followed by the comment. For the automatic documentation tools only the first line of comment is used for every variable. Thus this line should be self contained and not refer to a previous line:

Counter example:    XCOORD = X value of some detector
===============     YCOORD = Y   "    "  "      "

Example

*CD ITEXAM
      PARAMETER (JLENGT=8)
      COMMON/ITEXAM/NHITIT,IADDIT(JLENGT),IAMBIT(JLENGT),ILAYIT(JLENGT),
     +              PHITIT(JLENGT),SRHOIT,PHI0IT,DR00IT,CHIQIT
*IF DOC
C
C! This is a global comment of an example COMDECK
C
C
C JLENGT  : Number of layers in ITC
C NHITIT  : Number of hits on track
C IADDITi : i=1,NHITIT: ITC coordinate no. in ITCO bank
C IAMBITi : i=1,NHITIT: ambiguity used,  = 1 if first;= 2 if second
C ILAYITi : i=1,NHITIT: Layer no. of hit i
C PHITITi : i=1,NHITIT: phi of hit i
C SRHOIT  : sig*r0 of fit
C PHI0IT  : phi0 of fit
C DR00IT  : d0   of fit
C CHIQIT  : chisq of fit