12

我想链接到 RDoc 中文件的文档。但我能做的唯一方法是使用以下标记:

configuration.rb[link:files/configuration_rb.html]

我想以更好的方式做到这一点,如下所示:

<file>configuration.rb</file>

是否有任何现有的标记规则可以做到这一点?

编辑:当然我试过没有像这样的任何标记,configuration.rb但它显示的文件名没有链接:(

4

3 回答 3

7

在 rdoc 中显示链接

{Link label}[url ]

样本

{Killer question}[http://http://stackoverflow.com/questions/2230954/is-there-any-way-to-easily-link-a-file-in-rdoc]

将创建此问题的链接

于 2013-09-06T16:09:29.933 回答
2

自动超链接:MyClass my_class.rb def my_method;结尾; #my_method http:、mailto:、ftp:、www。链接:(到相对于--op 的本地文件系统)(图像的 URL 被呈现为内联图像标签) label[url](使用标签作为超链接文本){多字标签}[url](使用标签作为超链接文本)

红宝石:

ClassNames、source_files.rb 和 method_name_have_an_underscore 或 #methodnamewithhash 都超链接到它们的文档。

听起来您正在寻找第二个,但我以前从未使用过它,所以我无法为您提供一个完全有用的示例。

于 2010-02-19T15:15:24.317 回答
-1

尽量不要使用标记。

查看RDoc 自己的文档,他们在“路线图”段落中有类似的链接。他们的标记在这里

魔法!

于 2010-02-18T13:32:33.227 回答