Scenario-Based Code Inspection Tool with Hyperlink Tracking
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Existing code inspection tools are inadequate for scenario-based reading techniques, as they fail to efficiently track inspected lines, identify un inspected code, and support the inclusion of both changed and referential code segments, leading to incomplete code coverage and inefficient inspection processes.
Innovation Solution
A software tool that allows creating scenario paths with hyperlinks, annotating and marking inspected lines, and tracking inspection status, enabling reviewers to follow execution paths and ensure all code lines are inspected, while supporting the inclusion of both changed and unchanged code segments.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Manufacturing precision
If scenario-based reading techniques are used to examine specific execution paths, then code inspection coverage is improved, but the complexity of tracking inspected lines increases
Solution Approach 1:
The patent uses bookmarks to create a simplified copy representation of inspected code locations. Instead of complex tracking structures, the system creates bookmark objects that replicate essential location information, making tracking manageable while maintaining scenario-based inspection coverage
Solution Approach 2:
The patent introduces bookmarks as an intermediary between the scenario-based inspection process and the tracking mechanism. These bookmarks serve as mediators that simplify the complexity of tracking by providing a standardized interface for marking and retrieving inspected locations across multiple code paths
2Manufacturing precision
If code segments are read multiple times to investigate different paths, then inspection thoroughness is improved, but the time required for inspection increases
Solution Approach 1:
The patent creates inspection packages in advance that pre-organize the code segments and scenarios to be inspected. By preparing the inspection path and grouping relevant code segments beforehand, reviewers can efficiently navigate through multiple code paths without unnecessary time loss
Solution Approach 2:
The system creates simplified copies of code segments within inspection packages, allowing reviewers to examine specific execution paths without repeatedly loading and navigating the entire codebase. This copying approach enables efficient multiple-pass inspection of critical segments
3Manufacturing precision
If a tool provides detailed tracking of inspected lines, then inspection completeness is improved, but the ease of operation decreases
Solution Approach 1:
The patent uses bookmarks as simplified copies that represent inspected locations. Instead of complex data structures, bookmarks provide an easy-to-use interface where reviewers can mark and track inspected lines through simple operations, maintaining completeness while improving ease of operation
Solution Approach 2:
The bookmark system automatically manages tracking information without requiring complex manual intervention. The tool self-updates the inspection status as bookmarks are added or modified, reducing the operational burden on reviewers while maintaining detailed tracking of inspection completeness
Data Source
AI summary
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.