Rdoc cheatsheet

Basic RDoc format

# Foo.
#
# @example
#
#   y
#   g
#
# @param [String] param_name The xx and xx.
#
# @see https://example.com/
#
# @return [true] if so

Inline

*bold*
_emphasized_
+code+

https://www.example.com/
See Models::User@Examples
{Google}[https://google.com/]

Skip

def input # :nodoc:

module MyModule # :nodoc: all

Definition lists

# == Definition lists
#
# list::  hi.
# +foo+:: parameterized

# == Definition lists
# [foo]   also
# [bar]   like this

Return types

# @return [String]
# @return [String, nil] the name

Callseq

# :call-seq:
#   ARGF.readlines(sep=$/)     -> array
#   ARGF.readlines(limit)      -> array
#   ARGF.readlines(sep, limit) -> array
#
#   ARGF.to_a(sep=$/)     -> array
#   ARGF.to_a(limit)      -> array
#   ARGF.to_a(sep, limit) -> array

Category

# :category: Utilities

Sections

# :section: Expiry methods
# methods relating to expiring

def expire!
def expired?
...

Using tomdoc

# :markup: TomDoc

Place this at the beginning of the file.

Also see

• http://rdoc.rubyforge.org/RDoc/Markup.html
• https://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md