Some aids for program documentation

R. S. Scowen · Software Practice and Experience · 1977

Abstract The documentation of computer programs can be considerably eased and standardized using the programs described in this paper. They are basically machine‐ and language‐independent, possess a simple structure, use one serial input and one output stream, and require no backing store. The code size for each program is a few thousand bytes and the time for running them is dominated by that needed for input and output. The programs are: INDEX (gives an index of all identifiers used in a program). POLISH (paginates a program listing so that the global structure is evident). WATER (helps find misprints in computer‐readable reports). UNDOC (creates a live program from its documented form). Also included are examples of the output from these programs.

Read the paper · More papers on PaperTik