Giter Club home page Giter Club logo

vs-docblockr's Introduction

VS DocBlockr (Visual Studio Code)

Actions Status Coverage Status GitHub release Visual Studio Marketplace Installs

A Visual Studio Code port of the Atom package Docblockr.

Extension page

Currently three languages have been implemented:

  • C
  • Java
  • JavaScript
  • PHP
  • SCSS
  • TypeScript
  • Vue.js

More languages will be implemented in the future.

Usage

Type /** above the code you want to apply a docblock too, and press enter.

Demonstration of extension

The Render from selection command is also available in the command palette.

Demonstration of extension

This command can also be used to parse code that spans multiple lines. (Note: you autocomplete multiple lines with the /** keybinding)

Demonstration of extension

Settings

Currently the following configuration settings have been implemented:

Title Description
Align Tags Whether or not to automatically align the parameters, return, or variable tags.
Block Comment Style Which doc block comment style to use (default|drupal).
Column Spacing Minimum number of spaces between columns.
New Lines Between Tags Whether or not to add new lines between tags.
Default return tag Whether or not to display a return tag.
*SCSS Comment Close Type of block level comment closing to use.
*SCSS Comment Open Type of block level comment opening to use.
*SCSS Comment Separator Type of block level separator closing to use.

* Note: VS DocBlockr does not currently support autocompletion of SASS blocks with ///.

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.