8

Rails (2.3.8) プロジェクトのドキュメントを生成したいと考えています。私が試したとき

rake doc:rails
rake doc:rerails

標準の ruby​​ クラスを含むすべてのクラスと vendor ディレクトリ内のすべての ruby​​ ファイル (プラグインなど) のドキュメントを作成します。

次のディレクトリにあるルビークラス、ファイルのみのrdocドキュメントを作成するにはどうすればよいですか

  1. app フォルダー (すべてのモデル、コントローラー、およびビュー)
  2. 構成フォルダー
  3. lib フォルダー
4

2 に答える 2

12

これを Rakefile に追加しました。

RDoc::Task.new :rdoc do |rdoc|
  rdoc.main = "README.rdoc"

  rdoc.rdoc_files.include("README.rdoc", "doc/*.rdoc", "app/**/*.rb", "lib/*.rb", "config/**/*.rb")
  #change above to fit needs

  rdoc.title = "App Documentation"
  rdoc.options << "--all" 
end

次に実行します。

rake rdoc

詳細については、RDoc::Task ドキュメントを参照してくださいhttp://rdoc.rubyforge.org/RDoc/Task.html

確かに私は Rails 3 アプリを使用していますが、これは同じように機能すると思います。

于 2011-11-28T13:50:49.300 に答える