System and method for documenting and displaying computer program code
First Claim
1. Using a computer system having a processing unit, an input device and an output device, a method for displaying and annotating program code in a program code file, the program code file including a plurality of tokens, each token defined in accordance with a programming language, the method comprising the steps of:
- retrieving and parsing the program code file to produce a token record having a token name, a token type, and a token scope for each of the plurality of tokens in the program code file;
retrieving a set of token annotation objects, each of the token annotation objects having a token name data field, a token type data field, a token scope data field and a reference to a corresponding annotation;
comparing each retrieved and parsed token record with the set of token annotation objects to determine whether the retrieved and parsed token record matches a token annotation object in the set of token annotation objects; and
displaying on the output device the program code file with the tokens that have a matching token annotation object in a visually distinct manner.
2 Assignments
0 Petitions
Accused Products
Abstract
A system and method for documenting and displaying computer program code comprises a token annotation unit, a comment analyzer, a token parsing library, and a code outline unit. The token parsing library parses a program comprising related program code files into a set of constituent tokens. The token annotation unit selectively associates one or more annotations with tokens in a program by creating a token annotation object. When program code is displayed, the token annotation unit visually identifies each annotated token present according to a display style. The token annotation unit presents annotations corresponding to an annotated token in response to the selection of the annotated token during program code display.
-
Citations
20 Claims
-
1. Using a computer system having a processing unit, an input device and an output device, a method for displaying and annotating program code in a program code file, the program code file including a plurality of tokens, each token defined in accordance with a programming language, the method comprising the steps of:
-
retrieving and parsing the program code file to produce a token record having a token name, a token type, and a token scope for each of the plurality of tokens in the program code file; retrieving a set of token annotation objects, each of the token annotation objects having a token name data field, a token type data field, a token scope data field and a reference to a corresponding annotation; comparing each retrieved and parsed token record with the set of token annotation objects to determine whether the retrieved and parsed token record matches a token annotation object in the set of token annotation objects; and displaying on the output device the program code file with the tokens that have a matching token annotation object in a visually distinct manner. - View Dependent Claims (2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14)
-
-
15. An apparatus for displaying and annotating program code in a program code file having a plurality of tokens defined in accordance with a programming language, the apparatus comprising:
-
means for parsing the program code file to produce a token record having a token name, a token type, and a token scope for each of the plurality of tokens in the program code file, the parsing means having an input and an output, the input of the parsing means coupled to receive the program code file; means for retrieving a set of token annotation objects, the retrieving means having an input and an output; means for comparing each retrieved and parsed token record with the set of token annotation objects to determine whether the retrieved and parsed token record matches a token annotation object in the set of token annotation objects;
said comparing means having a first input, a second input and an output, the first input of said comparing means coupled to the output of the parsing means and the second input of said comparing means coupled to the output of the retrieving means; andmeans for displaying the program code file with the tokens that have a matching token annotation object in a visually distinct manner, the displaying means having an input and an output, the input of the displaying means coupled to the output of said comparing means. - View Dependent Claims (16, 17, 18, 19, 20)
-
Specification