6

ruby Twitter gem ソースコードをダウンロードし、.d 経由でインストールした yard を使用してドキュメントを生成しようとしていgem install yardます。rakefile で、次のものが見つかりました。これは、Twitter gem のドキュメントを生成するために使用されていると思われます。

require 'yard'
YARD::Rake::YardocTask.new

私require yardはirbで実行しようとしましYARD::Rake::YardocTask.newたが、何も起こりませんでした。

正しい軌道に乗るのを手伝ってもらえますか?

4

1 に答える 1

15

YARD ドキュメントから:

2 番目にわかりやすいのは、Rake タスクを介してドキュメントを生成することです。これを行うには、次を に追加しますRakefile。

YARD::Rake::YardocTask.new do |t|
  t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
  t.options = ['--any', '--extra', '--opts'] # optional
end

filesとのoptions設定はどちらもオプションです。filesはデフォルトでlib/**/*.rb、options追加したいオプションを表します。yardoc --helpここでも、シェルに入力すると、オプションの完全なリストが表示されます。OPTS 環境変数を使用して、Rake コマンドラインでオプションをオーバーライドすることもできます。

$ rake yard OPTS='--any --extra --opts'

要約すると、 に追加YARD::Rake::YardocTask.newした後Rakefile、 を実行しますrake yard。

于 2012-10-23T03:12:13.790 に答える