nästa upp förra
Nästa: Innehåll Upp: Programkommentar Förra: Programkommentar

Form

All information ska höra till en rubrik. Följande rubriker kan finnas, i den inbördes ordning som anges: NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, ENVIRONMENT, FILES, SEE ALSO, DIAGNOSTICS, NOTES, VERSION, AUTHOR.

NAME-, SYNOPSIS-, DESCRIPTION-, och AUTHOR-delen skall alltid finnas med. De övriga delarna finns med om de behövs, vilket flera av dem nästan alltid gör för alla program utom de minsta.

NAME ska stå direkt efter "/* " (tre tecken). Alla de övriga raderna i modulkommentaren inleds med " * " (tre tecken). Varje annan rubrik (utöver NAME) ska stå direkt efter denna inledning, på den rad rubriken finns.

Bortsett från inledningen (" * "), gäller följande: En rubrik ska stå ensamma på sin rad, och den text som faller under rubriken börjar direkt på raden efter och är indenterad två steg. Det ska vara en tom rad innan varje rubrik, utom för NAME, som börjar direkt (efter "/* ").



Jonas Mölsä
Sat Sep 13 13:46:34 MET DST 1997