• Packages
  • Themes
  • Documentation
  • Blog
  • Discussions
Sign in

atom-easy-jsdoc

JSDoc style comments for javascript development
tgandrews
4.12.5 51,486
51
  • Repo
  • Bugs
  • Versions
  • License
Flag as spam or malicious

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.

I think this package is bad news.

Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.

  • Terms of Use
  • Privacy
  • Code of Conduct
  • Releases
  • FAQ
  • Contact
with by