Object oriented programming system with displayable natural language documentation through dual translation of program source code

• US 5,953,526 A
• Filed: 11/10/1997
• Issued: 09/14/1999
• Est. Priority Date: 11/10/1997
• Status: Expired due to Fees

• Current Assignee: International Business Machines Corporation
• Original Assignee: International Business Machines Corporation
• Inventors: Day, Don Rutledge, Fox, Otis Otto
• Primary Examiner(s): Hafiz, Tariq R.
• Assistant Examiner(s): Khatri, Anil
• Application Number:
  US08/967,653
• Time in Patent Office: 673 Days
• Field of Search: 364/138, 395/701, 395/500, 395/700, 395/704, 395/683, 395/710, 395/712, 707/10, 434/350
• US Class Current: 717/108
• CPC Class Codes: G06F 8/73 Program documentation

Abstract

A computer controlled object oriented programming system for interfacing a plurality of programming objects with each other to provide combination objects combining programming functions of the objects, each object including predetermined interface data defining a required common interface with the other programming objects in a framework of events, attributes and methods for manipulating the attributes. These objects may be combined with each other via their common interfaces to form combination objects and such combination objects may in turn be further combined with other objects and combination objects to form objects of increasing complexity which function as complete programs. There is provided a displayable output of documentation for the programming objects in which the basic documentation provided for an object oriented program by its developers may be added to or modified without the need to change the framework of the objects in the program. To accomplish this, the invention involves the combination of two documentation functions: 1) the basic documentation program which translates source code data within the object framework, and 2) an implementation translating a portion of the object source code data which is outside of the object framework.

Claims

1. In a computer controlled object oriented programming system having means for interfacing a plurality of programming objects wherein said programming objects may be initial programming objects and combinations of such initial programming objects combining functions of said initial objects, and each programming object respectively having a framework including data attributes, methods of manipulating such attributes and predetermined interface data defining a required common interface with the other programming objects, a system for providing a displayable output of documentation for said programming objects comprising:

means for storing the source code of at least one of said programming objects,

a documentation programming object having said interface data defining said required common interface and means for translating a first portion of said source code into an output in a language readable by a computer controlled display system to display said first portion of said source code in natural language documentation, and

means without said interface data defining said required common interface for translating a selected second portion of said source code into an output in the same language as said language readable by said computer controlled display to display said second portion of said source code in the same natural language documentation complementing the documentation of said first portion.

2. The computer controlled object oriented programming system of claim 1, further including means for obtaining from said source code identifiers for selecting said second portion of said source code.

3. The computer controlled object oriented programming system of claim 2, further including:

means for compiling machine code for driving said computer from at least part of said source code, and

means for applying said identifiers to select said second portion of said source from said machine code compiled from said part of said source code.

4. The computer controlled object oriented programming system of claim 1 wherein:

said object oriented programming system is the Java Programming System,

said documentation programming object is JavaDoc, and

said language readable by said computer controlled system is HTML.

5. The method of claim 1, further including the step of obtaining from said source code, identifiers for selecting said second portion of said source code.

6. The method of claim 5, further including the steps of

compiling machine code for driving said computer from at least part of said source code, and

applying said identifiers to select said second portion of said source from said machine code compiled from said part of said source code.

7. In a computer implemented method of object oriented programming including interfacing a plurality of programming objects wherein said programming objects may be initial programming objects and combinations of such initial programming objects combining functions of said initial objects, and each programming object respectively having a framework including data attributes, methods of manipulating such attributes and predetermined interface data defining a required common interface with the other programming objects, a method for providing a displayable output of documentation for said programming objects comprising:

storing the source code of at least one of said programming objects,

translating via said required common interface, a first portion of said source code into an output in a language readable by a computer controlled display system to display said first portion of said source code in natural language documentation, and

translating independently of said required common interface a selected second portion of said source code into an output in the same language as said language readable by said computer controlled display to display said second portion of said source code in the same natural language documentation complementing the documentation of said first portion.

8. The method of claim 7 wherein:

said object oriented programming system is the Java Programming System,

said documentation programming object is JavaDoc, and

said language readable by said computer controlled system is HTML.

9. In a computer program having data structures included on a computer readable medium comprising an object oriented programming system having means for interfacing a plurality of programming objects wherein said programming objects may be initial programming objects and combinations of such initial programming objects combining functions of said initial objects, and each programming object respectively having a framework including data attributes, methods of manipulating such attributes and predetermined interface data defining a required common interface with the other programming objects, a system for providing a displayable output of documentation for said programming objects comprising:

means for storing the source code of at least one of said programming objects,

a documentation programming object having said interface data defining said required common interface and means for translating a first portion of said source code into an output in a language readable by a computer controlled display system to display said first portion of said source code in natural language documentation, and

means without said interface data defining said required common interface for translating a selected second portion of said source code into an output in the same language as said language readable by said computer controlled display to display said second portion of said source code in the same natural language documentation complementing the documentation of said first portion.

10. The computer program according to claim 9, further including means for obtaining from said source code identifiers for selecting said second portion of said source code.

11. The computer program according to claim 10, further including:

means for compiling machine code for driving said computer from at least part of said source code, and

means for applying said identifiers to select said second portion of said source from said machine code compiled from said part of said source code.

12. In a computer controlled object oriented programming system having means for interfacing a plurality of programming objects wherein said programming objects may be initial programming objects and combinations of such initial programming objects combining functions of said initial objects, and each programming object respectively having a framework including data attributes, methods of manipulating such attributes and predetermined interface data defining a required common interface with the other programming objects, a system for providing a displayable output of documentation for said programming objects comprising:

means for storing the source code of at least one of said programming objects,

means for compiling machine code for driving said computer from at least part of said source code,

a documentation programming object having said interface data defining said required common interface and means for translating a first portion of said source code into an output in a language readable by a computer controlled display system to display said first portion of said source code in natural language documentation including comments directly related to functions within said framework of said one programming object,

means without said interface data defining said required common interface for translating a selected second portion of said source code into an output in the same language as said language readable by said computer controlled display to display said second portion of said source code in the same natural language documentation including data not directly related to said functions to complement the documentation of said first portion,

means for obtaining from said source code, identifiers for selecting said second portion of said source code, and

means for applying said identifiers to select said second portion of said source code from said compiled machine code.

13. The computer controlled object oriented programming system of claim 12, wherein said displayed second portion includes message data displayed during the running of said computer.

14. The computer controlled object oriented programming system of claim 13 wherein:

said object oriented programming system is the Java Programming System,

said documentation programming object is JavaDoc,

said language readable by said computer controlled system is HTML,

said source code is .java,

said machine code is .Class, and

said comments are handled as doc comments by JavaDoc.

15. In a computer implemented method of object oriented programming including interfacing a plurality of programming objects wherein said programming objects may be initial programming objects and combinations of such initial programming objects combining functions of said initial objects, and each programming object respectively having a framework including data attributes, methods of manipulating such attributes and predetermined interface data defining a required common interface with the other programming objects, a method for providing a displayable output of documentation for said programming objects comprising:

storing the source code of at least one of said programming objects,

compiling machine code for driving said computer from at least part of said source code,

translating via said required common interface, a first portion of said source code into an output in a language readable by a computer controlled display system to display said first portion of said source code in natural language documentation including comments directly related to functions within said framework of said one programming object,

translating independently of said required common interface a selected second portion of said source code into an output in the same language as said language readable by said computer controlled display to display said second portion of said source code in the same natural language documentation including data not directly related to said functions to complement the documentation of said first portion,

obtaining from said source code, identifiers for selecting said second portion of said source code, and

applying said identifiers to select said second portion of said source code from said compiled machine code.

16. The method of claim 15, wherein said displayed second portion includes message data displayed during the running of said computer.

17. The method of claim 16 wherein:

said object oriented programming system is the Java Programming System,

said documentation programming object is JavaDoc,

said language readable by said computer controlled system is HTML,

said source code is .Java,

said machine code is .Class, and

said comments are handled as doc comments by JavaDoc.

18. In a computer program having data structures included on a computer readable medium comprising an object oriented programming system having means for interfacing a plurality of programming objects wherein said programming objects may be initial programming objects and combinations of such initial programming objects combining functions of said initial objects, and each programming object respectively having a framework including data attributes, methods of manipulating such attributes and predetermined interface data defining a required common interface with the other programming objects, a system for providing a displayable output of documentation for said programming objects comprising:

means for storing the source code of at least one of said programming objects,

means for compiling machine code for driving said computer from at least part of said source code,

a documentation programming object having said interface data defining said required common interface and means for translating a first portion of said source code into an output in a language readable by a computer controlled display system to display said first portion of said source code in natural language documentation including comments directly related to functions within said framework of said one programming object,

means without said interface data defining said required common interface for translating a selected second portion of said source code into an output in the same language as said language readable by said computer controlled display to display said second portion of said source code in the same natural language documentation including data not directly related to said functions to complement the documentation of said first portion,

means for obtaining from said source code, identifiers for selecting said second portion of said source code, and

means for applying said identifiers to select said second portion of said source code from said compiled machine code.

19. The computer program according to claim 18, wherein said displayed second portion includes message data displayed during the running of said computer.