Software tool for scenario-based code inspections
View Patent ↗A computer program product for scenario-based source code inspection is provided. The computer program product comprises a computer-usable data carrier storing instructions that, when executed by a computer, cause the computer to display a plurality of functions, the plurality of functions comprising: a first function for creating one or more scenario paths in the source code by providing the ability to create hyperlinks from subroutine/macro calls to the subroutine or macro source in the code and commentary addition; and a second function for inspecting code in execution order and inspecting uninspected lines of code by providing the ability to annotate the code with any errors and observations found and mark lines inspected.
1. A computer program product for scenario-based source code inspection, the computer program product comprising:
one or more non-transitory machine readable media storing instructions that, when executed by a computer, cause the computer to display a plurality of functions, the plurality of functions comprising:
a first function for creating one or more scenario paths, wherein the one or more scenario paths include at least one execution order in the source code, the first function including the ability to create hyperlinks from calls to a subroutine or macro source in the code and commentary addition; and
a second function for inspecting code in execution order of the one or more scenario paths and inspecting uninspected lines of code including the ability to annotate the code with any errors and observations found and mark lines inspected wherein the plurality of functions further comprise:
a third function for providing a Page List frame consisting of the page numbers for pages in an inspection package that contain differences between the source code to be inspected and a reference version.
2. The computer program product of claim 1 , wherein the source code comprises new code or bug fixes.
3. The computer program product of claim 1 , wherein the one or more scenario paths specify a set of inputs.
4. The computer program product of claim 3 , wherein the second function presents the source code in execution order of the one or more scenario paths.
5. The computer program product of claim 1 , wherein the plurality of functions further comprises:
a fourth function for providing a code view frame that contains diffmarked code with hyperlinks between code pages, annotation markers, and markings for lines inspected and a bottom frame for creating, updating, and deleting comments about the code and for creating, editing, and deleting hyperlinks between code pages.
6. The computer program product of claim 1 , wherein all hyperlinks, inspection markings, and annotations are persistent, all hyperlinks and annotations are seen by everyone, and all inspection markings are per reviewer.
7. A system for scenario-based source code inspection, the system comprising:
an input device;
a display device in communication with the input device;
a user processing device in communication with the display device; and
a program storage medium for storing the source code and a source code inspection tool, wherein the source code and the source code inspection tool are displayed on the display device and the software inspection tool comprises a plurality of functions including:
a first function for creating one or more scenario paths, wherein the one or more scenario paths include an execution order in the source code, the first function including the ability to create hyperlinks from calls to a subroutine or macro source in the code and commentary addition; and
a second function for inspecting code in execution order and inspecting uninspected lines of code including the ability to annotate the code with any errors and observations found and mark lines inspected wherein the plurality of functions further comprise:
a third function for providing a Page List frame consisting of the page numbers for pages in an inspection package that contain differences between the source code to be inspected and a reference version.
8. The system of claim 7 , wherein the source code comprises new code or bug fixes.
9. The system of claim 7 , wherein the first function further comprises the ability to add commentary in the scenario paths specifying special considerations special conditions.
10. The system of claim 9 , wherein the special considerations comprise what the code is modeling in real life or what a segment of the scenario is achieving and the special conditions comprise a data value intended to be used for the scenario at a logic branching statement.
11. The system of claim 7 , wherein the plurality of functions further comprises:
a fourth function for providing a code view frame that contains diffmarked code with hyperlinks between code pages, annotation markers, and markings for lines inspected and a bottom frame for creating, updating, and deleting comments about the code and for creating, editing, and deleting hyperlinks between code pages.
12. The system of claim 7 , wherein all hyperlinks, inspection markings, and annotations are persistent, all hyperlinks and annotations are seen by everyone, and all inspection markings are per reviewer.
13. A method comprising:
creating one or more scenarios in source code that are to be inspected by one or more reviewers;
reviewing each of the scenarios by reading text and following the hyperlinks;
marking lines of source code inspected with a software tool;
determining whether all lines of code to be inspected have been inspected; and
recording an inspection disposition when all lines of code to be inspected have been inspected wherein the software tool further comprises:
a third function for providing a Page List frame consisting of the page numbers for pages in an inspection package that contain differences between the source code to be inspected and a reference version.
14. The method of claim 13 , wherein the source code comprises new code or bug fixes.
15. The method of claim 13 , wherein the software tool further comprises a first function for creating one or more scenario paths, wherein the one or more scenario paths includes at least one execution order in the source code, the first function including the ability to create hyperlinks from calls to a subroutine or macro source in the code and commentary addition, and a second function for inspecting code in the at least one execution order and inspecting uninspected lines of code by providing the ability to annotate the code with any errors and observations found and mark lines inspected.
16. The method of claim 13 , wherein the software tool further comprises:
a fourth function for providing a code view frame that contains diffmarked code with hyperlinks between code pages, annotation markers, and markings for lines inspected and a bottom frame for creating, updating, and deleting comments about the code and for creating, editing, and deleting hyperlinks between code pages.
17. The method of claim 13 , wherein all hyperlinks, inspection markings, and annotations are persistent, all hyperlinks and annotations are seen by everyone, and all inspection markings are per reviewer.