Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Ruby Doc for code and other stuff

 
Trilochan Bharadwaj
Ranch Hand
Posts: 100
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I just got started with Ruby (I am from Java world, and have played around with Haskell and Scala a bit); I am just wondering: What are the things that are wrong in this code, if someone can point it out, like from best practices and convention perspective and also How do I Ruby-Doc this, javadoc was pretty straight forward (especially with Eclipse), (I am using Eclipse Ruby IDE right now), here's my code:

 
Lasse Koskela
author
Sheriff
Posts: 11962
5
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
From the command line you can do "rdoc [path to .rb file]" to generate the RDoc for a single file.
Most people tend to use build scripts (usually Rake) for doing this stuff for the whole project, though.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic