RDocとYARDの比較 - 2011-05-11 - ククログ
リファレンスマニュアルの記述方法を検討し、埋め込み方式のドキュメントツールを採用したとします。Rubyで埋め込み方式のドキュメントツールを使うとしたらRDocかYARDになります1。 RDocからYARDへの移行方法につなげたいのでYARDを使う方向で話を進めたいわけですが、その前にRDocとYARDの背景や機能の違いを確認しておきましょう。 RDocの背景 RDocはRuby 1.8.1からRuby本体に標準添付されています。Ruby1.8.1は2003年のクリスマスにリリースされているので、もう7年くらい前になります。Ruby本体や標準添付されているライブラリもRDoc用にドキュメントが書かれていますし、Rubyで標準的なドキュメントツールといえばRDocという存在です。 RDocは2004年くらいまではRuby本体のリポジトリ上で活発に開発されていましたが、それから数年は開発が停滞し
リファレンスマニュアルの記述方法 - 2011-05-05 - ククログ
Rubyではライブラリのリファレンスマニュアル作成のドキュメントツールとしてRDocが標準となっています。これは、古くからあるという理由とRuby本体に標準添付されているという理由からです。しかし、RDocはそれほど活発に開発されていないため、最近のドキュメントツールとして機能不足と言わざるをえません1。どのような機能が足りないのかについては別の機会にします。 数年前からYARD（Yey! A Ruby Documentation Tool）というドキュメントツールが開発されています。YARDはRDocとの互換性を残したまま機能を拡張しているため、RDocからの移行も容易です。実は、YARDは第2回フクオカRuby大賞（SSLの証明書の期限が切れているので警告がでます）に「Improving Documentation in the Ruby Community」というタイトルで応募してい
File: README — Documentation for yard (0.9.36)
YARD: Yay! A Ruby Documentation Tool Synopsis YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Below is a summary of some of YARD's notable features. Feature
YARD,RDoc 比較 - Qiita
YARD - A Ruby Documentation Tool http://yardoc.org/ Rails/Rubyドキュメントをキレイに生成するYARD、早見表付き！ - 酒と泪とRubyとRailsと http://morizyun.github.io/blog/yard-rails-ruby-gem-document-html/ RDoc- Document Generator for Ruby Source http://rdoc.sourceforge.net/ library rdoc http://doc.ruby-lang.org/ja/1.9.2/library/rdoc.html RDocの基本的な書き方メモ - maeshimaの日記 http://maeshima.hateblo.jp/entry/20100725/1280055512 RDocおさらい R
RubyにはBooleanというクラスは存在しないがYARDでは指定できる - コード日進月歩
YARDのドキュメントみたら、え、とおもったのでメモ 前提の話 RubyにはTrueClassとFalseClassしかなく、Booleanというクラスは存在しない。 x = true => true x.class => TrueClass x = false => false x.class => FalseClass YARDでの記載 []内に複数指定できるので以下の書き方ができる。 # @param [true,false] 0を下回ればtrue,そうでなければfalse def under_zero?(target) target.to_i < 0 end が、ドキュメントを読むと [true,false] みたいなときは Boolean という書き方もできるよ とある、なので # @param [Boolean] 0を下回ればtrue,そうでなければfalse def unde
Rubyで定義したメソッドに戻り値のYARD用ドキュメントを書く方法 - 2013-04-18 - ククログ
YARD - A Ruby Documentation Tool
What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc
NAMAKESUGI | YARDがすごい
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
YARD cheatsheet
Ruby の YARD（Yardoc） の @ タグ - きたももんががきたん。
Rails/Rubyドキュメントをキレイに生成するYARD、早見表付き！ 