3 ms·
I've become fond of Yard (http://yardoc.org/ http://yardoc.org/), especially after speaking with Loren Segal at MountainWest RubyConf in March. I'm planning on
by jamesbritt 17y ago
I've become fond of Yard (http://yardoc.org/ http://yardoc.org/), especially after speaking with Loren Segal at MountainWest RubyConf in March. I'm planning on moving ruby-doc.org over to yard when I can make sufficient time.
You can debate whether a doc tool is too clunky or has too many options or too many @tags, but in practice the biggest issue with docs is the lack of them. I don't really see Yet Another Doc Format changing that.
Yard is nicely done, in active use, and works nicely with Disqus for user comments. I feel comfortable poking around the code, and know I can get support form the developers and community. This may also be true for Tomdoc, but I'm more reluctant to go for a newer format and code base.
(Side rant: One thing that would really get my attention in a doc tool would be parsing usage of attr_* and documenting the results as the methods the are, and not as Java-ish virtual attributes. )
- gcampbell 17y agoI hadn't looked at Yard in a while, actually, but http://yardoc.org/docs/ruby-core http://yardoc.org/docs/ruby-core is a pretty compelling example of some nice output, especially given that it's generated from the C code.