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

Question

我正在为正确的RDoc语法寻找一个好的,可靠的参考.建议？我似乎无法找到任何清楚显示的内容:

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

Answer 1

可以在这里找到一个官方的rdoc示例,其中包含GitHub源代码.

rdoc.rubyforge.org上的文档似乎比rdoc.sourceforge.net(顺便提一下 2003修改日期)的版本更完整.

此外,还有一个很好的示例来源:Ruby核心和stdlib文档.例如,看看从类方法中的一种File类:

File.atime(file_name)=>时间

返回指定文件的最后访问时间作为Time对象).

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/Markup.html