Skip to content

Instantly share code, notes, and snippets.

@subelsky
Last active August 26, 2016 12:40
Show Gist options
  • Save subelsky/0b15efc43faad17594cc9d2dfe0f08fc to your computer and use it in GitHub Desktop.
Save subelsky/0b15efc43faad17594cc9d2dfe0f08fc to your computer and use it in GitHub Desktop.
Vim UltiSnips snippet for adding Ruby YARD tags to a method
# We document all of our Ruby code with YARD tags; see http://www.rubydoc.info/gems/yard/file/docs/Tags.md
# This snippet helps add all of the common tags to a method that I use everyday.
# The format is used by the UltiSnips Vim plugin; see https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt
snippet yd "YARD tags"
# ${1:Method description}
# @param ${2:obj} [${3:Object}] ${4:description}
# ${0} @yield
# @yieldparam obj [Object]
# @yieldreturn
# @return
# @see
# @note
endsnippet
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment