Program Documentation Header

From sasCommunity

Jump to: navigation, search

Below is a skeleton of the documentation header I use in my programs.

See examples in the Bibliography.

 /*       Name: MyProgram.sas

-----------------------------------------------------------------------
Requirements  :   description: 
                      purpose: 
                               
-----------------------------------------------------------------------
Context . . . : program group: 
                program  type: 
                    SAS  type: 

-----------------------------------------------------------------------
Specifications:         input: 
                      process: 
                       output: 
------------------------------------------------------------------------
Usage . . . . : 
------------------------------------------------------------------------
Information . :        author: Ronald J. Fehd
07May03 RJF2

note: 
------------------------------------------------------------------------
Example . . . :/* ...................... ............. disable here: ***

;/*** end Program Documentation Header ... ***/

[edit] Bibliography

sugi30.067, Ronald Fehd, Journeymen's Tools: The Writing for Reading and Reuse Program Header http://www2.sas.com/proceedings/sugi30/067-30.pdf Coder's Corner, 4 p.

sugi30.004, Ronald Fehd, Journeymen's Tools: Two Macros, ProgList and PutMvars, to Show Calling Sequence and Parameters of Routines http://www2.sas.com/proceedings/sugi30/004-30.pdf Applications Development, 8 p.

--macro maven == the radical programmer 10:09, 29 November 2007 (EST)

Personal tools