适当的RDoc语法是否有一个很好的，可靠的参考？

我正在寻找适当的RDoc语法的一个很好的，可靠的参考。建议？我似乎无法找到任何东西，清楚地表明：适当的RDoc语法是否有一个很好的，可靠的参考？

如何文档类的方法和参数
如何记录一类或类的方法做什么。

来源

2010-10-06 Levi Hackwith

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

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

另外，还有一个很好的例子来源：Ruby核心和stdlib文档。例如，看一看的类方法从File class：

File.atime（FILE_NAME）=>时间

返回上次访问时间命名文件作为时间目的）。

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

您可以查看原始的源代码，包括RDoc的标记，通过点击第一行（在实际RDoc的页面，而不是在我包含在这个答案的报价）。在这种情况下，该方法下实现的，但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。

来源

2010-10-06 06:00:51 bk1e

我只是在寻找这一点。请注意，http://rdoc.rubyforge.org/RDoc/Markup.html有（看来）官方规范。搜索：* RDoc标记参考* ** Darn！我真的应该也读过第二个评论** – serverhorror 2011-03-15 20:18:09

不知道这是否也适用于较新的版本，但对于我的1.9.3红宝石，它似乎不支持'--markup'选项（尝试使用[ 'markdown']（http://daringfireball.net/projects/markdown/）在http://rdoc.rubyforge.org/RDoc/Markup.html#label-Supported+Formats提到 - 我错过了什么吗？ – FriendFX 2013-11-20 05:06:40

rubyforge链接死亡 – 2014-09-02 15:44:51

由于RubyForge has been retired，这里是一个新的链接：

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

来源

2014-06-26 17:54:00

这一个也看起来很当前： http://docs.seattlerb.org/rdoc/RDoc/Markup.html – Steve 2014-07-15 19:39:18

旧链接现在已经死了，新版本。当前： http://ruby-doc.org/gems/docs/r/rdoc-4.1.2/RDoc/Markup.html – 2014-12-22 05:58:06

这是荒谬的。所有的红宝石doc链接已经死了，但这似乎工作：http://ruby-doc.org/stdlib-2.2.3/libdoc/rdoc/rdoc/RDoc/Markup.html但多久......？ – bronson 2015-10-12 07:56:21

适当的RDoc语法是否有一个很好的，可靠的参考？

回答

相关问题