リファレンスマニュアルの記述方法 - 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」というタイトルで応募してい

[tuto0621]

情報の少ない、リファレンスマニュアルを書くためのツールを網羅的に教えてくれる。

[tmtms]

最近は RDoc じゃなくて YARD ってのがいいのか。Yet Another Ruby Documentation の略かと思ったら違った