我在开发新宝石时使用珠宝商宝石。作为骨架的一部分,它设置了一组与 RDoc 相关的 rake 任务——主要的是rake rdoc
. 据我从 Rakefile 中得知,此任务使用该rake/rdoctask
库从我的 RDoc 注释生成 HTML 文档。
它智能地尝试引用我的 RDoc 注释中的类和方法。但是因为我有一个方法叫做user
,所以每次我写user
RDoc 生成器时都认为我引用了这个方法。根据RDoc 手册(在“记录源代码”的最后),可以通过在单词前加上反斜杠 (\) 来禁用此功能 - 例如\user
。
但就我而言,这不起作用。它只是在完成的 HTML 文档中输出反斜杠,并且仍然使用该单词作为交叉引用。
知道如何让它发挥作用吗?