Code Monkey home page Code Monkey logo

commented-vscode's Introduction

commented-vscode

A VS Code extension to automatically add comments to code.

Usage:

  • Highlight a section of code
  • Use "cmd+K" or "ctrl+k" to add a one-line comment that describes the highlighted code

MVP Demo:

commented_v0_demo.mp4

Setup:

  1. Navigate to source code:

    For MacOS:

    ~/.vscode/extensions/shreyaw.commented-0.0.2

    For Windows:

    C:\Users<YourUsername>.vscode\extensions\shreyaw.commented-0.0.2

  2. Update .env variables using script.py:

    python3 script.py "PYTHON_PATH=" "OPENAI_API_KEY="

  3. Refresh VSCode

Known Limitations:

  • Problems generating comment in longer files

Currently working on:

  • Robust comment-generation for all files of all lengths
  • Full codebase context when generating comments
  • Command to generate comments for entire files, directories, or codebases

commented-vscode's People

Contributors

shreya-51 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.