【发布时间】:2011-04-08 23:21:59
【问题描述】:
我在开发新宝石时使用了珠宝商宝石。作为骨架的一部分,它设置了一组与 RDoc 相关的 rake 任务——主要的是rake rdoc。据我从 Rakefile 中得知,此任务使用 rake/rdoctask 库从我的 RDoc cmets 生成 HTML 文档。
它智能地尝试引用我的 RDoc cmets 中的类和方法。但是因为我有一个名为user 的方法,所以每次我写user 时,RDoc 生成器都会认为我引用了这个方法。根据RDoc manual(在“记录源代码”的最后),可以通过在单词前加上反斜杠(\)来禁用它 - 例如\user.
但在我的情况下,这不起作用。它只是在完成的 HTML 文档中输出反斜杠,并且仍然使用该单词作为交叉引用。
知道如何让它工作吗?
【问题讨论】: