TomDoc for Ruby

TomDoc is a documentation specification for precise, human-readable documentation that is also machine-processable.

Method Documentation

Place documentation directly above the method definition with no blank line between.

Structure (in order)

1. Description (required) - Start with visibility, then plain sentences
2. Arguments (if any) - Parameter specifications
3. Yields (if block) - Block parameter descriptions
4. Examples (optional) - Usage demonstrations
5. Returns/Raises (required) - Output and exceptions

Visibility Prefixes