Dynamically creating source code comments
An approach for dynamically generating comments associated with software source code. The identifies a user accessing the software source code. The approach retrieves data associated with the software source code, e.g., server logs, requirements documents, etc. The approach identifies skills associated with the user. The approach, using artificial intelligence (AI), predicts the reason the user is accessing the software source code. The approach identifies navigation patterns based on the user access. The approach, using AI, dynamically generates comments for the user. The approach overlays the comments on the software sour code under review and displays the combination to the user.
1. A computer-implemented method for dynamically generating software source code comments, the computer-implemented method comprising:
identifying, by one or more processors, an identity of a user reviewing a portion of software source code;
retrieving, by one or more processors, data associated with a software source code module comprising the portion of the software source code;
identifying, by the one or more processors, one or more skills associated with the user;
predicting, by the one or more processors, a reason the user is reviewing the portion of software source code based on a first artificial intelligence (AI) analysis of the data;
identifying, by the one or more processors, a navigation pattern associated with the user and the portion of software source code;
generating dynamically, by the one or more processors, comments associated with the portion of software source code based on a second AI analysis based on factors comprising the identity, the one or more skills, the reason and the navigation pattern; and
displaying, by the one or more processors, the comments overlayed on the portion of software source code displayed to the user.
2. The computer-implemented method of claim 1 , wherein the identity of the user comprises a software developer, a software tester, a software development manager, a software architect, and a software analyst.
3. The computer-implemented method of claim 1 , wherein the data comprises one or more application logs, one or more server logs, one or more application maintenance tickets and one or more requirement documents.
4. The computer-implemented method of claim 1 , wherein the reason comprises application feature addition, application feature enhancement, application feature removal, application feature correction, application feature testing, application feature completeness, and application applicability for proposed purpose.
5. The computer-implemented method of claim 1 , wherein the navigation pattern comprises speed of the navigation and amount of time spent in the portion of software source code.
6. The computer-implemented method of claim 1 , wherein the identity, the reason and the one or more skills are stored as metadata associated with the comments in a software source code comment archive along with the comments.
7. The computer-implemented method of claim 1 , wherein the comments can be shared by different users of similar identity.
8. A computer program product for dynamically generating software source code comments, the computer program product comprising:
one or more non-transitory computer readable storage media and program instructions stored on the one or more non-transitory computer readable storage media, the program instructions comprising:
program instructions to identify an identity of a user reviewing a portion of software source code;
program instructions to retrieve data associated with a software source code module comprising the portion of the software source code;
program instructions to identify one or more skills associated with the user;
program instructions to predict a reason the user is reviewing the portion of software source code based on a first artificial intelligence (AI) analysis of the data;
program instructions to identify a navigation pattern associated with the user and the portion of software source code;
program instructions to dynamically generate comments associated with the portion of software source code based on a second AI analysis based on factors comprising the identity, the one or more skills, the reason and the navigation pattern; and
program instructions to display the comments overlayed on the portion of software source code displayed to the user.
9. The computer program product of claim 8 , wherein the identity of the user comprises a software developer, a software tester, a software development manager, a software architect, and a software analyst.
10. The computer program product of claim 8 , wherein the data comprises one or more application logs, one or more server logs, one or more application maintenance tickets and one or more requirement documents.
11. The computer program product of claim 8 , wherein the reason comprises application feature addition, application feature enhancement, application feature removal, application feature correction, application feature testing, application feature completeness, and application applicability for proposed purpose.
12. The computer program product of claim 8 , wherein the navigation pattern comprises speed of the navigation and amount of time spent in the portion of software source code.
13. The computer program product of claim 8 , wherein the identity, the reason and the one or more skills are stored as metadata associated with the comments in a software source code comment archive along with the comments.
14. The computer program product of claim 8 , wherein the comments can be shared by different users of similar identity.
15. A computer system for dynamically generating software source code comments, the computer system comprising:
one or more computer processors;
one or more non-transitory computer readable storage media; and
program instructions stored on the one or more non-transitory computer readable storage media, the program instructions comprising:
program instructions to identify an identity of a user reviewing a portion of software source code;
program instructions to retrieve data associated with a software source code module comprising the portion of the software source code;
program instructions to identify one or more skills associated with the user;
program instructions to predict a reason the user is reviewing the portion of software source code based on a first artificial intelligence (AI) analysis of the data;
program instructions to identify a navigation pattern associated with the user and the portion of software source code;
program instructions to dynamically generate comments associated with the portion of software source code based on a second AI analysis based on factors comprising the identity, the one or more skills, the reason and the navigation pattern; and
program instructions to display the comments overlayed on the portion of software source code displayed to the user.
16. The computer system of claim 15 , wherein the identity of the user comprises a software developer, a software tester, a software development manager, a software architect, and a software analyst.
17. The computer system of claim 15 , wherein the data comprises one or more application logs, one or more server logs, one or more application maintenance tickets and one or more requirement documents.
18. The computer system of claim 15 , wherein the reason comprises application feature addition, application feature enhancement, application feature removal, application feature correction, application feature testing, application feature completeness, and application applicability for proposed purpose.
19. The computer system of claim 15 , wherein the navigation pattern comprises speed of the navigation and amount of time spent in the portion of software source code.
20. The computer system of claim 15 , wherein the identity, the reason and the one or more skills are stored as metadata associated with the comments in a software source code comment archive along with the comments and the comments can be shared by different users of similar identity.