小编Chr*_*ley的帖子

我不确定这是否真的可行,但我试图通过在我们的app/models文件中添加范围的文档来使我们的rails应用程序的文档更完整.我想要尝试做的是:

# This is a description of what the scope does and the action that it performs
scope :newest_records, order("created_at desc").limit(50)

然后当我在应用程序上运行rdoc时,我希望将其newest_records列为公共类方法以及更传统的方法,这些方法将记录如下:

# some more documentation about this method
def self.a_class method
  ....
end

编辑

我意识到这个问题可能有点含糊不清.所以这里是一个澄清的尝试:目前,当我尝试在scope声明上方添加注释行时,我没有得到RDoc为该范围生成的文档.我知道RDoc可以获取元方法/属性,否则它不会在声明的文档中显示属性attr_accessor.所以我的问题是如何在我的文件中添加注释,以便:

• 该方法出现在我的RDoc生成的文档中
• 它看起来像一个公共类方法(而不是公共实例方法等)

所以我想知道的是以下是否可行.我有一个网站,我们使用标准的I18n gem进行国际化(在config/locales/*.yml中有翻译).目前我们依靠各种(非常不优雅的)修复来获取javascript以获取翻译的单词(主要通过使用HTML5数据属性).既然我们已经将我们的站点升级到Rails 3.1,并且我们喜欢新的资产管道,那么如果我们能够将我们的js文件国际化,那就更好了,如下所示:

应用程序/资产/ jsfile.js.erb

alert(<%= I18n.t('javascript.key.name') %>)

然后获取资产管道迭代文件以生成public/assets/jsfile.en.js,public/assets/jsfile.de.js等等(我猜测一个语言环境javascripts_include_tag也很有用)

有没有人知道任何可以做这种工作的例子/宝石/插件,或者是时候破解IDE并开始自己编写代码？