Skip to content

An extension for Visual Studio 2012+ to auto generate documentation comment stubs for JSDoc and VSDoc in JavaScript and TypeScript editors.

License

Notifications You must be signed in to change notification settings

mobermeyer/DocStubsJs

Repository files navigation

DocStubsJs

An extension for Visual Studio 2012+ to auto generate documentation comment stubs for JSDoc and VSDoc in JavaScript and TypeScript editors.

Contributing

In order to run Visual Studio's plugin development environment for this extension, you will need Visual Studio 2015 Professional (Ultimate or Premium work, too). You will also need the SDK for Visual Studio 2012 installed, too.

How it works

DocStubsJs is a fairly straight-forward plugin that uses events and string parsing to determine when and how to insert a document stub. It essentially just watches key-strokes for the identifying documentation comment bock initializers. ("///" for VSDoc, and "/**" for JSDoc) Once it has determined that these have been entered on an empty line, then it parses the lines surrounding it to determine whether to add a new comment line, create a documentation comment stub, or do nothing.

About

An extension for Visual Studio 2012+ to auto generate documentation comment stubs for JSDoc and VSDoc in JavaScript and TypeScript editors.

Resources

License

Stars

Watchers

Forks

Packages

No packages published