Merge pull request #132 from vitalk/jsdoc-snippets
javascript: Add snippets to write JSDoc documentation
This commit is contained in:
commit
335663d3c1
49
UltiSnips/javascript_jsdoc.snippets
Normal file
49
UltiSnips/javascript_jsdoc.snippets
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
# JSDoc snippets
|
||||||
|
|
||||||
|
snippet /* "A JSDoc comment" b
|
||||||
|
/**
|
||||||
|
* ${1:${VISUAL}}$0
|
||||||
|
*/
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @au "@author email (First Last)"
|
||||||
|
@author ${1:`!v g:snips_author_email`} (${2:`!v g:snips_author`})
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @li "@license Description"
|
||||||
|
@license ${1:MIT}$0
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @ver "@version Semantic version"
|
||||||
|
@version ${1:0.1.0}$0
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @fileo "@fileoverview Description" b
|
||||||
|
/**
|
||||||
|
* @fileoverview ${1:${VISUAL:A description of the file}}$0
|
||||||
|
*/
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @constr "@constructor"
|
||||||
|
@constructor
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @p "@param {Type} varname Description"
|
||||||
|
@param {${1:Type}} ${2:varname} ${3:Description}
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @ret "@return {Type} Description"
|
||||||
|
@return {${1:Type}} ${2:Description}
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @pri "@private"
|
||||||
|
@private
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @over "@override"
|
||||||
|
@override
|
||||||
|
endsnippet
|
||||||
|
|
||||||
|
snippet @pro "@protected"
|
||||||
|
@protected
|
||||||
|
endsnippet
|
Loading…
x
Reference in New Issue
Block a user