Basic Yard Syntax (contributions welcome)

yardoc-cheatsheet.rb

# Quick summary of the function
#
# {ObjectName#method Optional Title}
# {Class::CONSTANT Optional Title} 
# {#method_inside_current_namespace}
#
# @see #method
#
# @param one [Fixnum] First parameter
# @param two [Fixnum] Second parameter
# @return [Fixnum] Return value
def method(one, two)
  one + two
end

# This function accepts a block.
#
# @yield [a, b] Description of block
# @yieldparam [Fixnum] argname description
# @yieldreturn [Fixnum] description
def block
  yield 1, 2
end