Preparing rdoc for your Rails application

Many times we end up spending more time in writing technical documents about our application.

Here is the simple approach maintaining technical documents about your application. Rails framework provides option called rdoc.

There are some convention you can maintain while writing any method, these are as follows:

Write following code above each method.

 # *Description*
  # * 
  # *MethodRequestType*
  # * 
  # *Parameters*
  # * 
  # *Returns*
  # * 
  # *Errors*
  # * 

How you will generate rdoc? Go to the application and issue this command rake doc:app

This creates the rdoc for entire rails application and stores it in doc folder under application.