J
Jeremy McAnally
I just pushed a new release of dcov to Rubyforge. dcov is a tool to
help you analyze the documentation of your Ruby code. This release
builds on previous releases and checks coverage (i.e., is there
documentation at all?) and adds quality analysis (e.g., did you
document all the parameters? Is there an options list, and if so, is
it documented? and so on).
(Disclaimer: I realize quality is very subjective, and you are able to
write your own analyzers very easily if you'd like to do your own
subjective analysis)
Now, on to the release. This is version 0.2.1 (Fun and Fanciful
Edition). It will analyze your source code and produce an HTML report
of what it found out. It is invoked by simply running:
dcov my_file.rb my_other_file.rb that_file.rb
The coverage.html file will be created in the current working directory.
Please do use the RubyForge bug tracker or my inbox to file bugs. I'm
working on a better solution, but for now that will function. If
there's enough interest, I'll spin up a mailing list or you can join
me in #dcov on Freenode (please do! ChanServ isn't a very good
conversationalist).
You can get the release one of three ways:
(1) gem install dcov
(2) download it from RubyForge here: http://rubyforge.org/projects/dcov/
(3) grab it from svn: svn co svn://rubyforge.org/var/svn/dcov
Visit http://dcov.rubyforge.org/ to stay up to date on what's going on
with this project...
Cheers!
Jeremy
--
http://www.jeremymcanally.com/
My free Ruby e-book:
http://www.humblelittlerubybook.com/book/
My blogs:
http://www.mrneighborly.com/
http://www.rubyinpractice.com/
help you analyze the documentation of your Ruby code. This release
builds on previous releases and checks coverage (i.e., is there
documentation at all?) and adds quality analysis (e.g., did you
document all the parameters? Is there an options list, and if so, is
it documented? and so on).
(Disclaimer: I realize quality is very subjective, and you are able to
write your own analyzers very easily if you'd like to do your own
subjective analysis)
Now, on to the release. This is version 0.2.1 (Fun and Fanciful
Edition). It will analyze your source code and produce an HTML report
of what it found out. It is invoked by simply running:
dcov my_file.rb my_other_file.rb that_file.rb
The coverage.html file will be created in the current working directory.
Please do use the RubyForge bug tracker or my inbox to file bugs. I'm
working on a better solution, but for now that will function. If
there's enough interest, I'll spin up a mailing list or you can join
me in #dcov on Freenode (please do! ChanServ isn't a very good
conversationalist).
You can get the release one of three ways:
(1) gem install dcov
(2) download it from RubyForge here: http://rubyforge.org/projects/dcov/
(3) grab it from svn: svn co svn://rubyforge.org/var/svn/dcov
Visit http://dcov.rubyforge.org/ to stay up to date on what's going on
with this project...
Cheers!
Jeremy
--
http://www.jeremymcanally.com/
My free Ruby e-book:
http://www.humblelittlerubybook.com/book/
My blogs:
http://www.mrneighborly.com/
http://www.rubyinpractice.com/