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

jsdoc

JSDoc style comments for javascript development
craig-o
0.9.0 3,756
34
  • Repo
  • Bugs
  • Versions
  • License
Flag as spam or malicious

jsdoc package

Atom package for quick jsdoc comment generation.

Usage

Control-Shift-d 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 'javadoc';
}
/**
 * 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.) or single line (//) comment.

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