search

rubyworks / qed

Quality Ensured Documentation
http://rubyworks.github.com/qed
Other
31 stars 5 forks source link

Comment Run Mode #8

Closed trans closed 14 years ago

trans commented 14 years ago

Another cool feature would be able to ruby Ruby script thru QED and have it treat comments as a demonstration.

trans commented 14 years ago

This is now supported as of v2.3.0. Simply use the -c option and select Ruby files instead of the usual markup files.

A helpful trick for this is to double comment anything that should not be run by qed. e.g.

foo

This is useful when you comment out experimental code or temporary code, etc., or are commenting in-line and don't want QED to display the comment (in verbose mode).