Code Comments Generator: Elevating Code Clarity

Inspiration

Our project was inspired by the widespread challenge of maintaining clear and comprehensive code documentation in software development. The difficulty in writing and maintaining code comments led us to explore the potential of AI to address this issue effectively.

What We Learned

Throughout development, we gained insights into the capabilities of AI, the importance of quality training data, the significance of user-friendly design, and the value of user feedback for continuous improvement.

How We Built Our Project

We built our project using Python (Flask for the backend), GPT-3 from OpenAI for the AI model, and HTML/CSS/JavaScript for the user interface. Extensive data preprocessing and user feedback mechanisms were essential components.

Challenges We Faced

Our journey involved challenges in data collection, model fine-tuning, user interface design, security and privacy, and adapting to diverse coding styles. Despite these obstacles, our team's commitment resulted in a powerful tool to enhance code clarity in software development.

Built With

• apis
• css3
• flash
• html5
• javascript
• python