• Packages
  • Themes
  • Documentation
  • Blog
  • Discuss
Sign in

atom-esdoc

Atom package for quick esdoc comment generation.
  • #esdoc
  • #api
  • #doc
iocast
0.4.0 572
0
  • Repo
  • Bugs
  • Versions
  • License
Flag as spam or malicious

Atom ESDoc package

dependency status GitHub version

Atom package for quick esdoc comment generation. Forked from Atom easy JSDoc by Tom Andrews

Install

apm install esdoc

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 'esdoc';
}
/**
 * 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.).

Autocompletion

Pressing enter or tab after /** will yield a new line and will close the comment, if the following line is a valid JavaScript code.

Contribute

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

## Release

  • Add info to CHANGELOG.md.
  • Push everything

Update registry:

/Applications/Atom.app/Contents/Resources/app/apm/bin/apm publish vX.X.X

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