Code advisory system
An example operation may include one or more of storing code that adheres to predefined coding standards of one or more programming languages within a data store, reading source code from a code file, comparing the source code to the code stored within the data store to determine one or more recommended code changes to the source code, and displaying the one or more recommended code changes via a user interface.
1 . An apparatus comprising:
a data store configured to store code that adheres to predefined coding standards of one or more programming languages; and
a processor configured to:
read source code from a code file, wherein the code file comprises a header, the header comprising an identification of a programming language of the source code and a description of the source code;
compare the source code to programming statements stored in the data store which adhere to the predefined coding standards to determine one or more recommended code changes to the source code;
display the one or more recommended code changes with the source code via a user interface;
generate a readability score for the source code; and
in response to the readability score failing to meet a threshold, provide suggestions that improve a human readability of the source code.
2 . The apparatus of claim 1 , wherein the data store is configured to store a plurality of code files in a plurality of different programming languages which adheres to a plurality of predefined coding standards, respectively.
3 . The apparatus of claim 2 , wherein the processor is configured to compare the source code to code within the data store which adheres to a predefined coding standard of the identified programming language and configured to offer best practices based on the description in the header.
4 . The apparatus of claim 1 , wherein the processor is configured to identify one or more variables within the source code which do not adhere to the predefined coding standards and recommend one or more conforming variables identified from the data store.
5 . The apparatus of claim 1 , wherein the processor is configured to identify one or more class names within the source code which do not adhere to the predefined coding standards and recommend one or more conforming class names identified from the data store.
6 . The apparatus of claim 1 , wherein the processor is further configured to execute a search of the data store based on the source code to identify a similar pattern of code that adheres to the predefined coding standards and compare the source code to the similar pattern of code to determine the one or more recommended code changes.
7 . A method comprising:
storing code that adheres to predefined coding standards of one or more programming languages within a data store;
reading source code from a code file, wherein the code file comprises a header, the header comprising an identification of a programming language of the source code and a description of the source code;
comparing the source code to programming statements stored in the data store which adhere to the predefined coding standards to determine one or more recommended code changes to the source code, wherein the comparing comprises identifying one or more programming statements which do not adhere to the predefined coding standards within the source code and recommending the one or more conforming programming statements identified from the data store; and
displaying the one or more recommended code changes with the source code via a user interface.
8 . The method of claim 7 , wherein the data store is configured to store a plurality of code files in a plurality of different programming languages which adheres to a plurality of predefined coding standards, respectively.
9 . The method of claim 8 , wherein the reading further comprises comparing the source code to code within the data store which adheres to a predefined coding standard of the identified programming language.
10 . The method of claim 7 , wherein the comparing comprises identifying one or more variables within the source code which do not adhere to the predefined coding standards and recommending one or more conforming variables identified from the data store.
11 . The method of claim 7 , wherein the comparing comprises identifying one or more class names within the source code which do not adhere to the predefined coding standards and recommending one or more conforming class names identified from the data store.
12 . The method of claim 7 , wherein the comparing comprises executing a search of the data store based on the source code to identify a similar pattern of code that adheres to the predefined coding standards and comparing the source code to the similar pattern of code to determine the one or more recommended code changes.
13 . A computer-readable storage medium comprising instructions, that when read by a processor, cause the processor to perform a method comprising:
storing code that adheres to predefined coding standards of one or more programming languages within a data store;
reading source code from a code file, wherein the code file comprises a header, the header comprising an identification of a programming language of the source code and a description of the source code;
comparing the source code to predefined programming statements within the code stored the data store to determine one or more recommended code changes to the source code;
displaying the one or more recommended code changes with the source code via a user interface;
generating a readability score for the source code; and
in response to the readability score failing to meet a threshold, providing suggestions that improve a human readability of the source code.
14 . The computer-readable storage medium of claim 13 , wherein the data store is configured to store a plurality of code files in a plurality of different programming languages which adheres to a plurality of predefined coding standards, respectively.
15 . The computer-readable storage medium of claim 14 , wherein the reading further comprises comparing the source code to code within the data store which adheres to a predefined coding standard of the identified programming language.
16 . The computer-readable storage medium of claim 13 , wherein the comparing comprises identifying one or more variables within the source code which do not adhere to the predefined coding standards and recommending one or more conforming variables identified from the data store.
17 . The computer-readable storage medium of claim 13 , wherein the comparing comprises identifying one or more class names within the source code which do not adhere to the predefined coding standards and recommending one or more conforming variables identified from the data store.
18 . The computer-readable storage medium of claim 13 , wherein the comparing comprises executing a search of the data store based on the source code to identify a similar pattern of code that adheres to the predefined coding standards and comparing the source code to the similar pattern of code to determine the one or more recommended code changes.