JSDoc hot key for atom editor.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
keymaps
lib
menus
tests
.babelrc
.editorconfig
.eslintignore
.eslintrc.json
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
CONTRIBUTORS.md
LICENSE.md
README.md
package-lock.json
package.json

README.md

Atom easy JSDoc package

Greenkeeper badge travis status dependency status

Atom package for quick jsdoc comment generation. Forked from Atom JS Doc by Craig Offutt

Install

apm install atom-easy-jsdoc

Usage

Control-Shift-d or Control-Shift-j to add comment templates.

To add comments for any piece of code, position the cursor anywhere on the line preceding the line you wish to comment on.

/**
 * functionComment - description
 *  
 * @param  {type} argA description
 * @param  {type} argB description
 * @param  {type} argC description
 * @return {type}      description
 */
function functionComment (argA, argB, argC) {
    return 'jsdoc';
}
/**
 * This is an empty comment
 */
var a = 'A';

Autocontinue

Comments now are automatically continued if the user hits enter (new line event) while inside of a block (/**..etc.).

Beta version

A complete rewrite with tests and using an AST instead of regular expressions is enabled behind the beta flag. Please note this is a true beta and although it works on my projects your mileage may vary.

Contribute

I'll be adding features periodically, however bug fixes, feature requests, and pull requests are all welcome.