# \[ANN\] dcov (the documentation analyzer for Ruby code) v.0.1

**URL:** <https://www.ruby-forum.com/t/ann-dcov-the-documentation-analyzer-for-ruby-code-v-0-1/108850>\
**Category:** Ruby\
**Created:** [July 8, 2007, 3:22am UTC](https://www.ruby-forum.com/t/ann-dcov-the-documentation-analyzer-for-ruby-code-v-0-1/108850 "2007-07-08T03:22:49Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![Jeremy\_McAnally](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/c89c15/32.png) [@Jeremy\_McAnally](https://www.ruby-forum.com/u/Jeremy_McAnally)\
**Post date:** [July 8, 2007, 3:22am UTC](https://www.ruby-forum.com/t/ann-dcov-the-documentation-analyzer-for-ruby-code-v-0-1/108850/1 "2007-07-08T03:22:49Z")

</div>

I pushed version 0.1 of my Google Summer of Code project – dcov – to  
RubyForge yesterday, and I hope you guys can take advantage of it (and  
let me know if it breaks! :)).

dcov is a tool to help you analyze the documentation of your Ruby  
code. At the present, it only checks for the presence of  
documentation and generates a report based on that, but in the future  
it will check for “quality” (e.g., did you document all the  
parameters? Is there an options list, and if so, is it documented?  
and so on). See my post about documentation quality on  
[http://blog.mrneighborly.com/](http://blog.mrneighborly.com/) if you’d like to voice your opinion on  
what should be used to measure quality. (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.1 (Young and Feeble  
Edition). It will analyze your source code and produce an HTML report  
(using Ruport currently) of what it found out. It it 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 (right now) 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.

You can get the release one of three ways:  
(1) gem install dcov  
(2) download it from RubyForge here: [http://rubyforge.org/projects/dcov/](http://rubyforge.org/projects/dcov/)  
(3) grab it from svn: svn co svn://rubyforge.org/var/svn/dcov

Visit [http://dcov.rubyforge.org/](http://dcov.rubyforge.org/) to stay up to date on what’s going on  
with this project…

Enjoy,  
Jeremy

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

> **[Resume Builder](https://resumebuild.com/)**
>
> RESUME BUILDER Online. Impressive Resumes Made Easy! Get hired with the professional Resume Builder that will make you stand out from the crowd! Start Now!

My free Ruby e-book:  
[http://www.humblelittlerubybook.com/book/](http://www.humblelittlerubybook.com/book/)

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/)