Source code for the documentation-generator-pii extension on VSCode.
🎉 Features
- Generates a documentation from custom comments in seconds
- Documentation in Markdown format only
- Supports many languages ( Python, Javascript, C++, C#, Ruby ... )
- Smart comments ( ChatGPT integration )
💪 Benefits
- Faster documentation creation
- Improved code readability
- Increased productivity and time saving
🛠 Requirements
📹 Demo
Insert gif or link to demo
💻 Installation
Search for it in the extension marketplace or click here. link here
Open the settings view, search for the extension and paste your own API token. You might need to relaunch the extension afterwards.
🐛 Known Issues
- Formatting bug on some functions
- Parser bugs if the language comment symbol is used in a code snippet
- Comment ID generation might lag
🙅♂️ Limitations
- Code becomes unreadable if a toddlers uses the extension
- Syntax of custom comments hard not admirable
- We need custom comments
📝 TODO
- Support HTML and PDF
- More designs
- Bug fixes
| |
