Win a copy of Succeeding with AI this week in the Artificial Intelligence and Machine Learning forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
  • Campbell Ritchie
  • Paul Clapham
  • Ron McLeod
  • Liutauras Vilda
  • Junilu Lacar
  • Tim Cooke
  • Jeanne Boyarsky
  • Knute Snortum
Saloon Keepers:
  • Stephan van Hulst
  • Tim Moores
  • Tim Holloway
  • Carey Brown
  • Piet Souris
  • salvin francis
  • fred rosenberger
  • Frits Walraven

Ruby Doc for code and other stuff

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

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:

Posts: 11962
  • 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.
A tiny monkey bit me and I got tiny ads:
ScroogeXHTML 8.7 - RTF to HTML5 and XHTML converter
    Bookmark Topic Watch Topic
  • New Topic