# Reference for rdoc conventions

**URL:** <https://www.ruby-forum.com/t/reference-for-rdoc-conventions/174643>\
**Category:** Ruby\
**Created:** [August 30, 2009, 9:57pm UTC](https://www.ruby-forum.com/t/reference-for-rdoc-conventions/174643 "2009-08-30T21:57:30Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![ate50eggs](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/fbc32d/32.png) [@ate50eggs](https://www.ruby-forum.com/u/ate50eggs)\
**Post date:** [August 30, 2009, 9:57pm UTC](https://www.ruby-forum.com/t/reference-for-rdoc-conventions/174643/1 "2009-08-30T21:57:30Z")

</div>

Are there any good references for rdoc conventions used to document  
classes, methods, etc? I’ve found plenty of rdoc references that  
explain the basic syntax, but I haven’t found anything about  
conventions for defining class usage, method usage, argument types,  
exceptions, etc. I’ve looked at various libraries for examples, but  
style varies a bit here and there.

-Nathan