Question

我正在使用带有Ruby 1.9.2p138的Rdoc 2.58。当我使用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命令。

RDoc不生成源文件

1 个答案: