☜ | First Line Convention1995 Version of ANSI (Equivalent to Current ISO Version) of Standard | ☞ |
The first line of every routine shall be used for documentation.
The format is:
label ls ; [ owner ] [ ; [ date ] [ ; description ] ... ]
where
owner | ::= | [ contact ] [ pkgnam ] |
contact | ::= | routeaddr |
NOTE: As defined by INTERNET RFC 822. Quoted strings are not permitted.
pkgnam | ::= | L prg |
prg | ::= | │ │ │ │ │ │ |
ident digit - _ % |
│ │ │ │ │ │ |
... | (Note: hyphen) (Note: underscore) (Note: percent) |
date | ::= | year month day [ hour minute [ sec ] [ zoneoffset ] ] |
year | ::= | digit digit digit digit |
month | ::= | digit digit |
day | ::= | digit digit |
hour | ::= | digit digit |
minute | ::= | digit digit |
sec | ::= | digit digit |
zoneoffset | ::= | │ │ │ │ │ |
Z
|
│ │ │ │ │ |
description | ::= | any of the characters in graphic except the semicolon |
Semantic description:
The first line is a formatted M comment line labeled with the name of the routine. The contact is an electronic mail address for complaints, suggestions, or questions. The pkgpgm list is used to classify the "position" of the routine in the package/program hierarchy. prgs are listed from left-to-right as most- to least-significant.
The date is in local time unless a zoneoffset is given. A zoneoffset of "Z" implies (Zulu) GMT and a numeric valued zoneoffset is the differential to local time from GMT.
The label, ls, and first semicolon are required. The other three fields are optional as long as their semicolon position relative to the others is maintained.
Examples:
DR2 ;UTILITY;DR;DRS;19761115;DATE READ
TAG ;<MAIL-MAN@VA.GOV>,JUNK;;EXAMPLE OF OMITTED FIELDS
M ;
RTN ;ABC,DEF,XYZ,GROUP;19760704;SCAN PAST; IN USER INPUT
NOTE: This standard does not affect the language specification.
Copyright © Standard Documents; 1977-2024 MUMPS Development Committee;
Copyright © Examples: 1995-2024 Ed de Moel;
Copyright © Annotations: 2003-2008 Jacquard Systems Research
Copyright © Annotations: 2008-2024 Ed de Moel.
This page most recently updated on 28-Nov-2011, 21:33:05.
For comments, contact Ed de Moel (demoel@jacquardsystems.com)