Sublime Snippets

jsdoc-class-header.sublime-snippet

<snippet>
    <content><![CDATA[
/**
 * Description
 * @constructor
 * @alias module:$TM_FILENAME
 * @param {TYPE} [param]
 * @param {TYPE} [?param.val=1j]
 * @example var x = new require('$TM_FILENAME');
 * @tutorial <tutorial-name>
 */
]]></content>
    <tabTrigger>docconfig</tabTrigger>
    <scope>source.js</scope>
    <description>/** configuration documentation */</description>
</snippet>

jsdoc-config.sublime-snippet

<snippet>
    <content><![CDATA[
/**
 * DESCRIPTION
 * @cfg <NAME>
 * @memberof $TM_FILENAME
 * @type <TYPE>
 * @default <VALUE>
 **/
]]></content>
    <tabTrigger>docconfig</tabTrigger>
    <scope>source.js</scope>
    <description>/** configuration documentation */</description>
</snippet>

jsdoc-instancemethod.sublime-snippet

<snippet>
    <content><![CDATA[
/**
 * DESCRIPTION
 * @method $TM_FILENAME#<METHODNAME>
 * @param {TYPE} NAME DESCRIPTION
 * @param {TYPE} NAME DESCRIPTION
 * @return {TYPE} DESCRIPTION
 **/
]]></content>
    <tabTrigger>docmeth</tabTrigger>
    <scope>source.js</scope>
    <description>/** method documentation */</description>
</snippet>

jsdoc-node-module.sublime-snippet

<snippet>
        <content><![CDATA[
/*jshint laxcomma: true, smarttabs: true, node:true, mocha: true*/
'use strict';
/**
 * $TM_FILENAME
 * @module $TM_FILENAME
 * @author $TM_FULLNAME
 * @since 0.0.1
 * @requires moduleA
 * @requires moduleB
 * @requires moduleC
 */

var moduleA = require( 'moduleA' )
  , moduleB = require( 'moduleB' )
  , moduleC = require( 'moduleC' )
  , THING
  ;

/**
 * Description
 * @constructor
 * @alias module:$TM_FILENAME
 * @param {TYPE} [param]
 * @param {TYPE} [?param.val=1j]
 * @example var x = new require('$TM_FILENAME');
 */
module.exports = THING = function THING( param ){

};

/**
 * This does something
 * @method module:$TM_FILENAME#method
 * @param {TYPE} var_1 description
 * @param {TYPE} var_2 description
 * @param {TYPE} var_3 description
 * @returns {TYPE}
 **/
THING.prototype.method = function method(var_1, var_2, var_3){
        /**
         * @name $TM_FILENAME.Thing#event
         * @event
         * @param {TYPE} name description
         **/
        this.emit('event', arg1, arg2)
}

]]></content>
        <!-- Optional: Set a tabTrigger to define how to trigger the snippet -->
        <tabTrigger>node-module</tabTrigger>
        <!-- Optional: Set a scope to limit where the snippet will trigger -->
        <scope>source.js</scope>
</snippet>

jsdoc-property.sublime-snippet

<snippet>
    <content><![CDATA[
/**
 * @readonly
 * @name {NAME}
 * @memberof $TM_FILEPATH
 * @property {TYPE} <NAME> <DESCRIPTION>
 **/
]]></content>
    <tabTrigger>docprop</tabTrigger>
    <scope>source.js</scope>
    <description>/** property documentation */</description>
</snippet>