Question

我正在使用RDoc为我的Ruby on Rails 3.0.7应用程序编写文档。在应用程序lib文件夹中，我有以下内容：

module ModuleName
  class ModuleName::User < ActiveRecord::Base
    #'CONSTANT' documentation text
    CONSTANT = 'Test constant'

    #'method_name' documentation text
    def method_name
      ...
    end
  end
end

当我尝试为上面的代码生成文档时，RDoc不会解析#'CONSTANT' documentation text和#'method_name' documentation text，因此输出文档是空白的。

1。如何让RDoc考虑模块“上下文”中的注释代码？

如果我使用:doc:指令，则无效，如下所示：

module ModuleName #:doc:
  class ModuleName::User < ActiveRecord::Base #:doc:
    #'CONSTANT' documentation text
    CONSTANT = 'Test constant' #:doc:

    #'method_name' documentation text
    def method_name #:doc:
      ...
    end
  end
end

我注意到我在 Class \ Module Index ：

中有这些

ModuleName
ModuleName::ModuleName
ModuleName::ModuleName::ModuleName
ModuleName::ModuleName::ModuleName::User

2。他们是什么意思？

记录常量和方法

0 个答案: