ruby - RDoc 不生成源文件

Question

我将 Rdoc 2.58 与 Ruby 1.9.2p138 结合使用。当我使用 Darkfish 格式(这是唯一的选择)生成我的 rdoc 文件时，我没有得到源代码预览。没有错误消息，并且正在为所有类生成 HTML 文件。

我已尝试更新 gem 并阅读帮助文件，但我没有看到任何解决此问题的方法。

这是一个已知问题吗？我还能尝试什么？

更新:

示例代码:

class Iamaclass
    def initialize
        @name = "superclass"
    end

    def get_name
        @name
    end

    def proud?
        true
    end
end

Rdoc 2.5.8 输出

Parsing sources...
100% [ 1/ 1]  someruby.rb                                                       

Generating Darkfish...

Files:         1
Classes:       1 (    1 undocumented)
Constants:     0 (    0 undocumented)
Modules:       0 (    0 undocumented)
Methods:       3 (    3 undocumented)
  0.00% documented

Elapsed: 0.0s

源代码不会在生成的 rdoc 中切换。

Rdoc 3.5.3 输出

100% [ 1/ 1]  someruby.rb                                                       

Generating Darkfish format into /Users/paul/dev/alesrelated/someruby/doc...

Files:      1

Classes:    1 (1 undocumented)
Modules:    0 (0 undocumented)
Constants:  0 (0 undocumented)
Attributes: 0 (0 undocumented)
Methods:    3 (3 undocumented)

Total:      4 (4 undocumented)
  0.00% documented

Elapsed: 0.1s

源代码确实在 html 输出中切换。

Answer 1

你需要在你的代码中添加注释，你可以尝试使用这个例如:

# A description about this class
class Iamaclass
 # A description about this method
 def initialize
    @name = "superclass"
 end

 # Another description about some other method
 def get_name
    @name
 end

 def proud?
    true
 end
end

在此之后，您可以尝试再次运行 rdoc 命令。