# RDoc and documenting model attributes?

**URL:** <https://www.ruby-forum.com/t/rdoc-and-documenting-model-attributes/123950>\
**Category:** Rails\
**Created:** [December 22, 2007, 4:15pm UTC](https://www.ruby-forum.com/t/rdoc-and-documenting-model-attributes/123950 "2007-12-22T16:15:55Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![Bryan\_Field-Elliot](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/f0a364/32.png) [@Bryan\_Field-Elliot](https://www.ruby-forum.com/u/Bryan_Field-Elliot)\
**Post date:** [December 22, 2007, 4:15pm UTC](https://www.ruby-forum.com/t/rdoc-and-documenting-model-attributes/123950/1 "2007-12-22T16:15:55Z")

</div>

I’d like to “rdoc” my rails application, and have rdoc also pick up the  
model attributes (i.e. the columns in my database tables), with the  
ability for me to comment them as well (i.e. "what is this column for?).

Is this something that rdoc, or rdoc + some other tool/technique, can  
do?

Thank you,

Bryan

---

<div class="post-metadata">

**Author:** ![Bryan\_Field-Elliot](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/f0a364/32.png) [@Bryan\_Field-Elliot](https://www.ruby-forum.com/u/Bryan_Field-Elliot)\
**Post date:** [December 22, 2007, 5:13pm UTC](https://www.ruby-forum.com/t/rdoc-and-documenting-model-attributes/123950/2 "2007-12-22T17:13:19Z")

</div>

You could get something basic using the annotate\_models plugin, then  
you could customize it at will.

–Jeremy

On Dec 22, 2007 10:15 AM, Bryan Field-Elliot [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
wrote:

> >

–  
[http://www.jeremymcanally.com/](http://www.jeremymcanally.com/)

My books:  
Ruby in Practice

> **[Ruby in Practice](https://www.manning.com/books/ruby-in-practice)**
>
> Like Ruby itself, Ruby in Practice will make you more productive. The book shows you practical techniques and strategies for small projects and large-scale environments. A cookbook-style reference, it gives you concrete examples of systems...

My free Ruby e-book

> **[Site not found · DreamHost](http://www.humblelittlerubybook.com/)**
>
> The owner of this domain has not yet uploaded their website.

My blogs:

> **[Site not found · DreamHost](http://www.mrneighborly.com/)**
>
> The owner of this domain has not yet uploaded their website.

[http://www.rubyinpractice.com/](http://www.rubyinpractice.com/)