ものづくりのブログ

うちのネコを題材にしたものづくりができたらいいなと思っていろいろ奮闘してます。

Ruby on rails ドキュメント自動生成(YARD)を使ってみる

yard はクラス定義やメソッド定義箇所に、YARDの記法に従いコメントをつけることで、ドキュメントを生成することができるツールです。

github.com

使い方

yard インストール

$ gem install yard

yard バージョン確認

$ yardoc --version

ヘルプ

$ yardoc --help

ドキュメント生成

$ yardoc sample.rb