RubyMine
 
Get RubyMine

Document code

Last modified: 31 October 2024

YARD and RDoc are the most popular documentation generation tools used in multiple libraries for documenting code. RubyMine allows you to view documentation written in a YARD or RDoc syntax using Quick Documentation Lookup. Moreover, RubyMine provides extended capabilities to work with YARD tags:

  • Create missing YARD tags

  • Check the validity of YARD tags and fix them

  • Utilize YARD tags for better code insight (for example, determining an object type, viewing parameter information for methods, and so on)