RailsでYARDをRakeから使う方法

Railsでドキュメント生成ツールの『RDoc』ではなく、『YARD』を使う方法を紹介します。

1. Gemfileにyardを追加

# Gemfile
group :doc do
  gem 'yard', require: false
end

追加後に、bundle installでgemを更新してください。

2. Rakeタスクで実行できるようにする

RDocの様にYARDをRakeタスクから実行できるようにしてみましょう。

bundle exec rails g task yardoc
# lib/tasks/yardoc.task
require 'yard'
require 'yard/rake/yardoc_task'

YARD::Rake::YardocTask.new do |t|
  t.files = %w(
      app/models/**/*.rb
      app/controllers/**/*.rb
      app/helpers/**/*.rb
      app/mailers/**/*.rb
      lib/**/*.rb
    )
  t.options = []
  t.options = %w(--debug --verbose) if $trace
end

これで、bundle exec rake yardocを実行すれば、doc/以下にドキュメントが生成されます。

 

RDocと比べて、YARDの方は書式タグが充実しているので、フォーマットに統一感が出て良いですね。

 

参考サイト


コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です