System and method for peer-based code quality analysis reporting
Systems and methods for peer-based code quality analysis reporting are provided. In accordance with an embodiment, a system can include a peer-based code quality analysis tool, executing on a computer, which is configured to receive one or more source code files, and perform an analysis of the one or more source code files based on a plurality of rules. The peer-based code quality analysis tool can further compare results of the analysis to peer results data to determine a percentile based score, and create an interactive report which includes the results of the analysis and the percentile based score.
1. A system for peer-based code quality analysis, the system comprising:
a computer, including a non-transitory computer readable medium and processor;
a peer-based code quality analysis tool, executing on the computer, which is configured to:
receive one or more source code files, wherein a source code file includes source code,
perform an analysis of the one or more source code files based
on a plurality of rules, wherein the analysis the peer-based code analysis tool is configured to perform includes:
a comment quality analysis of comments, and
a source code analysis of the source code to detect source code errors or inefficiencies using a rules-based analysis using the plurality of rules, a code style analysis, and a duplicate code analysis,
compare results of the analysis to peer results data to determine a percentile based score, wherein the peer results data includes analysis of similar implementations of the source
code by different peer entities, wherein the percentile based score provides an assessment of the source code relative to the similar implementations of the source code by the different peer entities, and
create an interactive report which includes the results of the analysis and the percentile based score.
2. The system of claim 1 wherein the comment quality analysis includes:
determining a number of single line and multiline comments;
determining a number of words in each comment;
removing whitespace from each comment to determine whether each comment is empty; and
determining a number of characters in each comment.
3. The system of claim 1 wherein the results of the analysis of the one or more source code files includes a total number of potential code issues, a ratio of a number of rules violations per a number of lines of code, and the comment quality analysis.
4. The system of claim 1 wherein each rule of the plurality of rules is associated with a priority number which indicates a relative importance of that rule.
5. The system of claim 1 wherein the interactive report can include a summary of the results of the analysis and details of each issue identified in the results of the analysis.
6. The system of claim 1 wherein the peer-based code analysis tool is further configured to compare the results of the analysis and the percentile based score with a plurality of compliance metrics.
7. A method for peer-based code quality analysis, the method comprising:
receiving, by a peer-based code quality analysis tool executing on a computer, one or more source code files;
performing an analysis of the one or more source code files based on a plurality of rules, wherein performing an analysis of the one or more source code files based on a plurality of rules, comprises:
performing a comment quality analysis,
performing a rules-based analysis using the plurality of rules,
performing a code style analysis, and
performing a duplicate code analysis;
comparing results of the analysis to peer results data to determine a percentile based score, wherein the peer results data includes analysis of similar implementations of the source code by different peer entities, wherein the percentile based score provides an assessment of the source code relative to the similar implementations of the source code by the different peer entities; and
creating an interactive report which includes the results of the analysis and the percentile based score.
8. The method of claim 7 wherein the comment quality analysis includes:
determining a number of single line and multiline comments;
determining a number of words in each comment;
removing whitespace from each comment; and
determining a number of characters in each comment.
9. The method of claim 7 wherein the results of the analysis of the one or more source code files includes a total number of potential code issues, a ratio of a number of rules violations per a number of lines of code, and the comment quality analysis.
10. The method of claim 7 wherein each rule of the plurality of rules is associated with a priority number which indicates a relative importance of that rule.
11. The method of claim 9 wherein the interactive report can include a summary of the results of the analysis and details of each issue identified in the results of the analysis.
12. The method of claim 7 further comprising comparing the results of the analysis and the percentile based score with a plurality of compliance metrics.
13. A non-transitory computer readable storage medium including instructions stored thereon which, when executed by a processor, cause the processor to perform the steps of:
receiving, by a peer-based code quality analysis tool executing on a computer, one or more source code files, wherein a source code file includes source code;
performing an analysis of the one or more source code files based on a plurality of rules, wherein performing an analysis of the one or more source code files based on a plurality of rules, comprises:
performing a comment quality analysis of comments, and
performing a source code analysis of the source code to detect
source code errors or inefficiencies using performing a rules-based analysis utilizing the plurality of rules,
performing a code style analysis, and
performing a duplicate code analysis;
comparing results of the analysis to peer results data to determine a percentile based score, wherein the peer results data includes analysis of similar implementations of the source code by different peer entities, wherein the percentile based score provides an assessment of the source code relative to the similar implementations of the source code by the different peer entities; and
creating an interactive report which includes the results of the analysis and the percentile based score.
14. The non-transitory computer readable storage medium of claim 13 wherein the comment quality analysis includes:
determining a number of single line and multiline comments;
determining a number of words in each comment;
removing whitespace from each comment; and
determining a number of characters in each comment.
15. The non-transitory computer readable storage medium of claim 13 wherein the results of the analysis of the one or more source code files includes a total number of potential code issues, a ratio of a number of rules violations per a number of lines of code, and the comment quality analysis.
16. The non-transitory computer readable storage medium of claim 15 wherein each rule of the plurality of rules is associated with a priority number which indicates a relative importance of that rule and wherein the interactive report can include a summary of the results of the analysis and details of each issue identified in the results of the analysis.
17. The non-transitory computer readable storage medium of claim 13 further comprising comparing the results of the analysis and the percentile based score with a plurality of compliance metrics.
18. A system for peer-based code quality analysis, the system comprising:
a computer, including a non-transitory computer readable medium and processor;
a peer-based code quality analysis tool, executing on the computer, which is configured to:
receive one or more source code files,
perform an analysis of the one or more source code files based
on a plurality of rules, wherein the analysis the peer-based code analysis tool is configured to perform includes a comment analysis of
comments to determine quality of comments and a source code analysis of the source code to detect source code errors or inefficiencies,
compare results of the analysis to peer results data to determine a percentile based score, wherein the peer results data includes analysis of similar implementations of the source code by different peer entities, wherein the percentile based score provides an
assessment of the source code relative to the similar implementations
of the source code by the different peer entities,
compare the results of the analysis and the percentile based score with a plurality of compliance metrics, and
create an interactive report which includes the results of the analysis and the percentile based score.