Software code comments management method and system supporting speech recognition technology
A system and method for enabling audio comments to be used when writing and executing code, during design time and run time. A code writer is hereby enabled to simultaneously write code and compose voice comments. These comments, divided into help comments, test items and variable comments, are subsequently recorded, stored, analyzed, prescribed and displayed using text to speech and voice recognition software. It is therefore possible to define test cases, execute vocal follow up on changes, and listen to comments and variables values, while running a program
1. A software code comments management system operating with and within a software code development environment and able to interact dynamically with the code segments, variables and characteristics, the system comprising:
a multimedia user interface that includes a graphic user interface that responds to voice commands;
a comment management component, for managing the comments;
a speech recognition module operatively connected to said multimedia user interface;
a database system for storing system data and control information; and
an output mechanism for outputting the comments or comments-code interaction results;
wherein said comment management component enables classifying comments into comments categories from the group comprising of: Help comments, Testing comments and Watch variable comments;
wherein said testing comments are used for quality control programs including:
integrating a test table structure with a comment object that specifies at least one test case for the code segment related to said comment;
automatic processing of the actual result for each said at least one test case in run time;
controlling the automatic test processing with the ability to plan to test all the cases, or part of them, or not to test at all;
evaluation of the value expressions in each said at least one test case in run time;
generating a test design document from said comment; and
generating a test result report from said automatic processing of the actual result.
2. A software code comments management system operating with and within a software code development environment and able to interact dynamically with the code segments, variables and characteristics, the system comprising:
a multimedia user interface that includes a graphic user interface that responds to voice commands;
a comment management component for managing a plurality of comments;
a speech recognition module operatively connected to said multimedia user interface;
a database system for storing system data and control information; and
an output mechanism for outputting the comments or comments-code interaction results;
wherein said comment management component enables classifying comments into comments categories from the group comprising of: Help comments, Testing comments and Watch variable comments;
wherein said watch variable comments enable follow up of variables and expressions values including:
adding to a comment at least one reference to code variables, to be displayed for tracing and debugging;
adding a description for every variable, to be displayed when evaluated;
displaying said evaluated variable by pronouncing said added description and said evaluated expression of said watch item while running a program in debug mode and running mode;
adding to a comment at least one reference to code expression, to be displayed for tracing and debugging;
adding a description for every expression, to be displayed when evaluated; and
displaying said evaluated expression by pronouncing said added description and said evaluated expression of said watch item while running a program in debug mode and running mode.