JSDuck Snippets

帮助你快速生成JSDuck注释

Content

• 生成 JSDuck @cfg 代码
• 生成 JSDuck @cfg 属性的代码
• 生成 JSDuck @cfg 是对象的代码
• 生成 JSDuck @event 代码
• 生成 JSDuck @example 代码
• 生成 JSDuck @inheritdoc 代码
• 生成 JSDuck @method 代码
• 生成 JSDuck @param 代码
• 生成 JSDuck @property 代码
• 生成 JSDuck @property 属性的代码
• 生成 JSDuck @property 是对象的代码
• 生成 JSDuck @return 属性的代码

Example

生成 JSDuck @cfg 代码

@cfg + tab

/**
 * @cfg {${1:类型}} [${2:配置名称}=${3:默认值}] ${4:(required)}
 * ${5:配置说明}
 */

生成 JSDuck @cfg 属性的代码

@cfg-attribute + tab

@cfg {${1:类型}} ${2:对象名称}.${3:属性名称} ${4:属性说明}

生成 JSDuck @cfg 是对象的代码

@cfg-object + tab

/**
 * @cfg {Object} ${1:对象名称}
 * ${2:对象说明}
 * @cfg {${3:类型}} ${1:对象名称}.${4:属性名称} ${5:属性说明}
 * @cfg {${6:类型}} ${1:对象名称}.${7:属性名称} ${8:属性说明}
 */

生成 JSDuck @event 代码

@event + tab

/**
 * @event ${1:事件名称}
 * ${2:事件说明}
 * @param {${3:类型}} ${4:参数名称}
 * @param {${5:类型}} ${6:参数名称}
 */

生成 JSDuck @example 代码

@example + tab

/**
 * ${1:组件介绍}
 *
 * # Example usage:
 *
 *     @example
 *
 *     Ext.create('${2:组件名称(使用全称)}', {
 *         ${3:配置1}: ${4:值},
 *         ${5:配置2}: ${6:值}
 *     });
 */

生成 JSDuck @inheritdoc 代码

@inheritdoc + tab

@inheritdoc ${1:父类名称}#${2:方法名称}

生成 JSDuck @method 代码

@method + tab

/**
 * @method ${1:方法名称}
 * ${2:方法说明}
 * @param {${3:类型}} ${4:参数名称}
 * @param {${5:类型}} ${6:参数名称}
 * @return {${7:类型}} ${8:返回值说明}
 */

生成 JSDuck @param 代码

@param + tab

@param {${1:类型}} ${2:参数名称}

生成 JSDuck @property 代码

@property + tab

/**
 * @property {${1:类型}} [${2:属性名称}=${3:默认值}]
 * ${4:属性说明}
 */

生成 JSDuck @property 属性的代码

@property-attribute + tab

@property {${1:类型}} ${2:对象名称}.${3:属性名称} ${4:属性说明}

生成 JSDuck @property 是对象的代码

@property-object + tab

/**
 * @property {Object} ${1:对象名称}
 * ${2:对象说明}
 * @property {${3:类型}} ${1:对象名称}.${4:属性名称} ${5:属性说明}
 * @property {${6:类型}} ${1:对象名称}.${7:属性名称} ${8:属性说明}
 */

生成 JSDuck @return 属性的代码

@return-attribute + tab

@return {${1:类型}} ${2:对象名称}.${3:属性名称} ${4:属性说明}