Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Creation Chatbot for Code #108

Closed
Iamanujosh opened this issue Oct 8, 2024 · 1 comment
Closed

Documentation Creation Chatbot for Code #108

Iamanujosh opened this issue Oct 8, 2024 · 1 comment

Comments

@Iamanujosh
Copy link

Code Analysis:

The chatbot should analyze code snippets and identify functions, methods, classes, and variables to generate appropriate documentation.
Language Support:

Initial support for Python, JavaScript, and Java with the ability to expand to other programming languages.
Customizable Documentation:

Users can specify the format of documentation (e.g., Python docstrings, JSDoc for JavaScript, Javadoc for Java).
Automatic Comment Generation:

Generate inline comments explaining complex sections of code to improve readability.
File Upload Support:

Allow users to upload entire code files, and the chatbot will parse and document the whole file.

image
image

@multiverseweb
Copy link
Owner

Hey @Iamanujosh, actually such chatbots already exist and we're looking for the unsolved problems faced by developers. We've also added a chatbot on our site, that possesses most of these features.
Hope you can raise issues for some more unsolved problems that you face as a developer! : )

@multiverseweb multiverseweb closed this as not planned Won't fix, can't repro, duplicate, stale Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants