标签: rdoc

似乎很多库/插件都使用这种语法:

  def self.included(base) # :nodoc:
    base.extend ClassMethods
  end

为什么这个:nodoc:部分是必要的？

我跑的时候

rake db:create

我收到此错误

rake aborted!
no such file to load -- rdoc/task

(See full trace by running task with --trace)

这是--trace

/usr/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:36:in `gem_original_require'
/usr/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:36:in `require'
/home/tpeg/rails_apps/Test/Rakefile:8
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/rake_module.rb:25:in `load'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/rake_module.rb:25:in `load_rakefile'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:495:in `raw_load_rakefile'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:78:in `load_rakefile'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:129:in `standard_exception_handling'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:77:in `load_rakefile'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:61:in `run'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:129:in `standard_exception_handling'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:59:in `run'
/usr/lib/ruby/gems/1.8/gems/rake-0.9.2/bin/rake:32
/usr/bin/rake:19:in `load'
/usr/bin/rake:19

我安装了rake 0.9.2和rdoc 3.11.我在我的应用程序目录中运行这些命令.

我在多个位置安装了几个宝石.

生成/重新生成的难/简单方法是什么:

• 所有这些已安装宝石的rdoc,一次全部？
• 所有这些已安装宝石的码数,一次全部？

我可以

sudo gem rdoc activerecord --no-ri

和

sudo gem rdoc actionpack --no-ri

这两个都给了我很好的文档.

但

sudo gem rdoc rails --no-ri

因为Rails宝石本身只是其他人的持有者,所以几乎没有给我任何东西.如何生成相应的http://api.rubyonrails.org/？

Rubyinside提到了一篇关于如何通过不安装RI或RDoc来加速gem安装的博客文章.

是否可以安装gem并随后在以后安装文档,这样你就可以在闲暇时加入急速和RTFM？

我想链接到RDoc中的文件的文档.但我唯一能做的就是使用以下标记:

configuration.rb[link:files/configuration_rb.html]

我想以更好的方式做到这一点,如下所示:

<file>configuration.rb</file>

是否有任何现有的标记规则来执行此操作？

编辑:当然我已经尝试过没有这样的任何标记,configuration.rb但它显示没有链接的文件名:(

我正在使用码来从rdoc文件生成Rails应用程序的文档.有AngularJS文档生成器,但它们如何连接以生成AngularJS + Rails应用程序的一个连贯文档？

例如,

$ gem install netaddr
Fetching: netaddr-1.5.1.gem (100%)
Successfully installed netaddr-1.5.1
ERROR:  While executing gem ... (NoMethodError)
    undefined method `reset' for RDoc::TopLevel:Class

安装任何新gem时,会引发NoMethodError异常.我搜索了它并搜索了RDoc和RubyGems GitHub存储库中的问题,但没有运气.

我的Ruby版本是

$ ruby -v
ruby 2.3.0p0 (2015-12-25 revision 53290) [x86_64-darwin15]

RubyGems版本是

$ gem -v
2.5.1

安装的RDoc版本是

$ gem search rdoc -l

*** LOCAL GEMS ***

rdoc (4.2.2, 4.2.1)

我在Mac OS X El Capitan上安装了带RVM的Ruby.

谢谢!

[更新] 2018/08/03

我没有长时间使用我的Macbook,所以直到现在我才忘记了这个问题.前天我收到了答复通知,今天我用相同的Macbook检查了我的情况.我发现我不再有问题,Ruby和Gems更新如下:

$ gem install netaddr
Fetching: netaddr-2.0.3.gem (100%)
Successfully installed netaddr-2.0.3
Parsing documentation for netaddr-2.0.3
Installing ri documentation for netaddr-2.0.3 …

我使用bdoc(用hanna进行格式化)作为查看我系统上安装的gems的rdoc文档的快速方法.但是,因为Bundler在安装gem时没有安装rdoc,所以每当我开始使用新gem或更新现有gem时,我都不得不手动生成它们.

有没有人知道是否有一种配置bundler的方法来安装ged时安装rdoc以避免我必须手动执行？我在Bundler源代码中找不到这个,也没有在配置手册中看到.

当我使用Visual Studio时,我习惯于在方法定义的开头只用几个按键来插入XML注释(我想///但它已经有一段时间了).有没有办法在开箱即用的RubyMine中的方法之前插入RDoc注释？如果是这样,键盘快捷键是什么？