ruby-on-rails – 为rails应用程序创建Rdoc

发布时间：2020-12-17 04:17:17 所属栏目：百科来源：网络整理

导读：我想为我的rails(2.3.8)项目生成一个文档.当我尝试 rake doc:railsrake doc:rerails 它为所有类创建文档,包括标准ruby类和供应商目录中的所有ruby文件(插件等). 如何仅为ruby类,以下目录中的文件创建rdoc文档 app文件夹(所有模型,控制器和视图) 配置文件夹 l

我想为我的rails(2.3.8)项目生成一个文档.当我尝试

rake doc:rails
rake doc:rerails

它为所有类创建文档,包括标准ruby类和供应商目录中的所有ruby文件(插件等).

如何仅为ruby类,以下目录中的文件创建rdoc文档

> app文件夹(所有模型,控制器和视图)
>配置文件夹
> lib文件夹

解决方法

我把它添加到我的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应用程序,但我认为这是相同的.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!