RubyFlow The Ruby and Rails community linklog

Beautiful standardized RDoc comments for your Ruby / Rails methods

I’d like to share with you the template that I employ for documenting Ruby methods. I like this template because it, like Javadoc, creates a somewhat standard, easily readable comment structure.

Post a comment

You can use basic HTML markup (e.g. <a>) or Markdown.

As you are not logged in, you will be
directed via GitHub to signup or sign in