Ruby - RDoc On and Off


You can stop RDoc from processing comments temporarily using #++ and #--, like so:

# This section is documented and read by RDoc. 
# This section is hidden from RDoc. 
# RDoc begins processing again here after the ++. 

This is useful in sections where you want to leave comments to yourself that aren't for general consumption.

RDoc doesn't process comments that are within methods, so your usual code comments are not used in the documentation produced.

Related Topic