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

我正在寻找正确的RDoc语法的良好且可靠的参考。建议？我似乎找不到任何能清楚显示的内容：

1. 如何记录类方法及其参数
2. 如何记录类或类方法的功能。

可以在这里找到官方的rdoc示例及其GitHub源代码。

在文档rdoc.rubyforge.org似乎比在版本更加完整rdoc.sourceforge.net（顺带有2003修改日期）。

此外，还有大量示例：Ruby核心和stdlib文档。例如，看一看来自Fileclass的class方法：

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。

由于RubyForge已停用，因此这里是一个新链接：

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