有适当的RDoc语法的一个很好的,可靠的参考?

我正在寻找适当的RDoc语法的一个很好的,可靠的参考。 build议? 我似乎无法find任何清楚显示的内容:

  1. 如何logging类方法及其参数
  2. 如何logging类或类的方法。

更新死链接最新的rdoc文档可以在这里findhttps://ruby.github.io/rdoc/ExampleRDoc_rdoc.html

rdoc.rubyforge.org上的文档似乎比rdoc.sourceforge.net (偶然有一个2003修改date)的版本更完整。

另外,还有一个很好的例子:Ruby核心和stdlib文档。 例如, File类中的一个类方法:

File.atime(file_name)=>时间

以Time对象的forms返回指定文件的上次访问时间)。

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:让你用你select的文本replace方法名和参数,这对类方法非常有用。 它还显示了如何通过缩进来显示示例代码的缩小字体,类似于Markdown。

由于RubyForge已经退役 ,这里有一个新的链接:

http://ruby-doc.org/gems/docs/r/rdoc-4.1.1/RDoc/Markup.html

Interesting Posts