Apparatus and method for extracting documentation text from a source code program

• US 4,860,203 A
• Filed: 09/17/1986
• Issued: 08/22/1989
• Est. Priority Date: 09/17/1986
• Status: Expired due to Fees

• Current Assignee: International Business Machines Corporation
• Original Assignee: International Business Machines Corporation
• Inventors: Hunter, Lawrence W., Corrigan, Colleen M., Modry, John A.
• Primary Examiner(s): NOT, DEFINED
• Assistant Examiner(s): NOT, DEFINED
• Application Number:
  US06/908,436
• Time in Patent Office: 1,070 Days
• Field of Search: 364/300, 364/200, 364/900
• US Class Current: 717/123
• CPC Class Codes: G06F 8/41 Compilation
• CPC Class Codes: G06F 8/73 Program documentation

Abstract

An apparatus for producing machine executable object code, a program listing and a listing of design documentation from a source code program consisting of a plurality of statements of implementation code including keywords and a plurality of statements of design documentation code wherein the design documentation code includes words corresponding to the keywords of the implementation code. The apparatus includes a processor for reading the source code program, a compiler for producing the machine executable object code from the implementation code, and the program listing. Furthermore, the apparatus includes an extractor that produces the design documentation by listing all of the design documentation code with the corresponding keywords in the order of appearance in the source program.

Claims

1. An apparatus for producing machine-executable object code, a program listing, and corresponding design documentation from a source program having a plurality of statements of implementation code including keywords, and a plurality of statements of design documentation code corresponding to the keywords of the implementation code, said apparatus comprising:

input means for reading said source program;

compilation means for producing

(a) the machine-executable object code from said implementation code, said machine-executable object code including executable commands derived from the implementation code keywords, and

(b) the program listing as a listing of all the implementation code in the order of appearance in the source program; and

extractor means for producing the design documentation by listing all the corresponding design documentation code with keywords in the order of appearance in the source program.

2. An apparatus according to claim 1 wherein said extractor means further includes means for producing a separate listing of the design documentation.

3. An apparatus for producing machine-executable object code, a program listing, and verified design documentation from a source program having a plurality of statements of implementation code including keywords, and corresponding design documentation code including keywords identical to the keywords of the corresponding implementation code, each of said design code statements further including a symbol designating the statement as design code, said apparatus comprising:

input means for reading said source program;

comparison means for verifying that the implementation code keywords include the corresponding design documentation code;

error indication means for signifying any locations in the source program where the implementation code does not include corresponding design documentation code;

compilation means for producing

(a) the machine-executable object code from said implementation code, said machine-executable object code including executable commands derived from the implementation code keywords, and

(b) the program listing as a listing of all the implementation code in the order of appearance in the source program; and

extractor means for producing the design documentation by listing all the design documentation code statements in the order of appearance in the source program, said design documentation including any error indication from said error indication means.

4. An apparatus according to claim 3 wherein the error indication means signifies locations where keywords do not include corresponding design documentation code.

5. An apparatus according to claim 4 wherein said extraction means further includes means for detecting said design code statement symbols and separating said design code documentation from said implementation code.

6. An apparatus according to claim 5 wherein said error indication means includes means for producing design comment templates printed to signify omissions of design documentation code.

7. A method for producing machine-executable object code, a program listing, and design documentation from a source code having a plurality of statements of implementation code including keywords, and corresponding design documentation code including keywords identical to the keywords of the corresponding implementation code, said method comprising the steps of:

reading said source program;

verifying that the implementation code keywords include the corresponding design code documentation;

signifying any locations in the source code program where the implementation code does not include corresponding documentation code;

producing machine-executable object code from said implementation code, said machine-executable object code including executable commands derived from the implementation code; and

producing the program listing as a listing of the source program; and

producing the design documentation by listing all the design documentation codes statements in the order of appearance in the source program.

8. A method according to claim 7 wherein said design documentation producing step includes the step of signifying locations where the design documentation code does not include keywords corresponding to the keywords of the implementation code.

9. A method according to claim 8 wherein said design documentation producing step includes the step of detecting a design code statement symbol and, in response thereto, separating said design documentation code from said implementation code.

10. A method according to claim 9 wherein said design documentation producing step includes the step of producing design comment templates printed to signify omissions of design documentation code.