Giter Club home page Giter Club logo

vscode-code-annotation's Introduction

Code Annotation Logo

Code Annotation

Create and track annotations from your source code without actually committing comments on your code.

The "Code Annotation" can be found in the Activity pane.

Features

  • Create an annotation from the source code, selecting the portion of code, right-clicking and adding a note
  • Keybinds for creating a new note from selection (Ctrl/Cmd + alt + n), or without selection, aka Plain note (Ctrl/Cmd + alt + p)
  • Track annotations on its own pane
  • Check/Uncheck items as you complete them
  • Generate a report in Markdown with a summary of the pending and completed items

Feedback and feature requests

Feel free to open issues and suggest new features for the extension.

Installing

You can install the latest version of the extension via the Visual Studio Marketplace here.

Using a VSIX file

Download the VSIX file and follow the steps on your VSCode:

  1. Go to the "Extensions" pane
  2. Click on the ... on the top right of the "Extensions" pane
  3. Select "Install from VSIX"
  4. Select the VSIX file you downloaded and click install

Development

  • For the development you'll need to use VSCode
  • Install Node/Npm
  • After forking/cloning the repository, run:
npm install
npm run compile
  • And to run/test the extension, go the the Run pane and hit the green button on Run Extension. This will open a new VSCode window with the extension enabled.

Creating a VSIX file for instalation

  • "Compile" the extension as usual
    • npm install
  • Install vsce
    • npm install -g vsce
  • Create the VSIX file
    • vsce package

vscode-code-annotation's People

Contributors

thamara avatar package-bot avatar jack073 avatar taismassaro avatar ftonato avatar prbart avatar barbaraalmeida avatar drishit96 avatar kud04rk avatar natandias 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.