我是第一次使用 RDoc,我遇到了一个有点麻烦的问题。我的课堂文档中有一行如下:
# * callingState
我在同一个项目中也有一门课,叫做 State。当我使用 RDoc 为我的项目生成文档时,它将上面行的“状态”部分链接到我的状态对象。
我宁愿不让它这样表现。有什么方法可以阻止 RDoc 自动创建此链接?快速谷歌搜索没有产生任何结果,但我可能只是使用错误的术语进行搜索。
我还没有看到这种具体情况发生。我试图重现它,但是当只有部分单词与某个类匹配时,没有创建链接。但是,我确实有很多不想链接到类或模块名称的情况。在大写单词前加上反斜杠对我来说是诀窍。
请参阅: 如何防止 RDoc 解析 URL?
RDoc 文档有一个关于Escaping Text Markup的部分,这对我有帮助。
* This will not be linked to \RDoc::RDoc#document