适当的RDOC语法是否有良好的，可靠的参考？

Question

我正在寻找适当的RDOC语法的良好参考。建议？我似乎找不到明确显示的东西：

1. 如何记录类方法及其参数
2. 如何记录类或班级方法的作用。

Answer 1

可以找到一个官方的RDOC示例 这里, ，与之 github源.

文档 rdoc.rubyforge.org 似乎比版本更完整 rdoc.sourceforge.net （顺便说一句，有2003年的修改日期）。

此外，还有一个很好的示例来源：Ruby Core和Stdlib文档。例如，从 File 班级:

file.atime（file_name）=>时间

返回命名文件作为时间对象的最后一个访问时间）。

File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003

您可以通过单击第一行（在实际的RDOC页面中，而不是在此答案中包含的报价中）查看原始源代码，包括RDOC标记。在这种情况下，该方法是在C中实现的，但是RDOC格式与Ruby中实施的格式相同：

/*
 *  call-seq:
 *     File.atime(file_name)  =>  time
 *  
 *  Returns the last access time for the named file as a Time object).
 *     
 *     File.atime("testfile")   #=> Wed Apr 09 08:51:48 CDT 2003
 *     
 */

从中您可以看到 call-seq: 让您用选择的文本替换方法名称和参数，这对于类方法非常有用。它还显示了如何通过缩进字体中的单词字体显示示例代码，类似于Markdown。

Answer 2

自从 Rubyforge已退休, ，这是一个新链接：

http://ruby-doc.org/stdlib-2.5.1/libdoc/rdoc/rdoc/rdoc/rdoc/markup.html