Skip to content

MikeMcElroy/atom-jsdoc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

JSDoc hot key for atom editor.

Resources

License

Stars

Watchers

Forks

Packages

No packages published