This is the README for the Syntax Squad extension. This extension is an AI-powered tool designed to assist developers by automatically generating comments and docstrings for code snippets, improving code readability and documentation.
Features
Generate Comments: Automatically generate meaningful comments for selected code. The extension uses AI to understand the code and provide relevant explanations.
Generate Docstrings: Create properly formatted docstrings for functions, supporting multiple formats such as Google, NumPy, and reST.
AI-Powered: The extension leverages machine learning to generate high-quality, context-aware comments and docstrings, helping improve code readability and documentation.
Seamless Integration: Works directly in Visual Studio Code with minimal setup. Just select your code and click to generate comments or docstrings.
Requirements
Visual Studio Code: Version 1.96.0 or above.
Backend API: The extension requires a locally running backend service for generating comments and docstrings. The backend should expose endpoints to generate comments and docstrings for code snippets:
POST http://127.0.0.1:8000/generate-comment
POST http://127.0.0.1:8000/generate-docstring
Ensure that you have the backend running before using the extension.
Extension Settings
This extension does not require any custom settings through the VS Code settings. However, make sure that the backend API is properly set up to allow comment and docstring generation.
Known Issues
API Dependency: The extension requires a local API running to generate comments and docstrings. If the API is not running, the extension will fail to generate output.
Limited Language Support: Currently, the extension supports common programming languages but may not perform well with some niche or less-known languages.
Release Notes
1.0.0
Initial release of Syntax Squad extension.
Generate comments for selected code snippets.
Generate docstrings for Python functions (Google, NumPy, reST formats).
1.0.1
Backend Deployed on Azure app service
No need to run backend locally
Following Extension Guidelines
Ensure that you've read through the extension guidelines and follow best practices for creating your extension.
