Documentation of a given code is one of the most important parts to ensure that it can still be used and understood by someone who has not developed it. However all programmers understand it is a very tedious and repetitive task. Thus to the automate documentation process, we have generated an AI supported extension which with a simple click of a button will generate appropriate documentation for a given piece of code. It works for all major languages (Python, Java, JavaScript etc). We have developed it through the use of Rest.API, we are able to take in a request from the client (highlighting the code and parse it) and in return after sending a post request to the server(Flask), find a description that best suits the piece of code using AI(OpenAI). After the comment has been generated by AI, the server send back to comment to the client so that it can be injected back into the code. This extension was developed with the intent to automate the task of commenting code for developers, helping them to generate meaningful comments so that more time can be invested in improving their code. As an extension, only those who download it can use it. This makes it great for those who maybe don’t want this extension (in case they mis-click it). Users can simply turn it off/not run the extension. Currently the extension is only supported on visual studio code however we plan to expand and integrate it other forms of IDE to increase accessibility. As for the product itself, we are looking to add additional functionality to the extension such as using the same AI module to auto generate code for a given input.

Share this project:

Updates