Browse Prior Art Database

Self Documenting Macros

IP.com Disclosure Number: IPCOM000078275D
Original Publication Date: 1972-Dec-01
Included in the Prior Art Database: 2005-Feb-25
Document File: 2 page(s) / 14K

Publishing Venue

IBM

Related People

Lichtman, A: AUTHOR

Abstract

The documentation and cross-referencing of macro instruction pairs (one macro obtains resource and another frees it) will help solve the learning, testing, maintaining, and extending of computer programs. The use of a special macro instruction operand described below provides an easy method for programmers to document their code.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 53% of the total text.

Page 1 of 2

Self Documenting Macros

The documentation and cross-referencing of macro instruction pairs (one macro obtains resource and another frees it) will help solve the learning, testing, maintaining, and extending of computer programs. The use of a special macro instruction operand described below provides an easy method for programmers to document their code.

A new macro instruction operand of a keyword format, can be defined for any new or existing macro instruction. This operand will: 1) describe the resource being obtained by the macro instruction, and; 2) specify the corresponding macro instruction(s) that release such resource by stating the symbols that appear in the name field of the corresponding macro instruction(s), and the names of the module(s) in which they appear. This same operand will appear in the macro instruction releasing the resource and will describe; 1) the resource released, and; 2) specify the corresponding macro instructions(s) that obtained the resource by stating the symbols that appear in the name field of the corresponding macro instruction(s), and the names of the modules in which they appear.

Upon expansion of the macro instruction, documentation will be generated containing the information presented in the macro instruction operand. This will result in a cross-referencing of macro instruction pairs that obtain and release resources. In addition. upon expansion of the macro instruction, a unique name can be generated that will appear in the cross-reference section of the assembly or compilation. This will allow a programmer to just scan the cross-reference section to determine if the program contains particular macro instructions, rather than do an instruction by instruction scan of the program. Format The macro operand may be of the following format:
COMMENT=(resource,(module(name1,name2,...),module(name,..),..]) Where resource describes the resource obtained or released module is the name of the module in which the corresponding member of the macro instruction pair is coded. na...