Ruby 对于正确的 RDoc 语法，是否有一个好的、可靠的参考

发布于10月06日

我正在寻找一个好的、可靠的参考来获得适当的RDoc语法.建议？我似乎找不到任何能清楚显示:

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

推荐答案

官方的rdoc示例可以在here中找到，其中包含GitHub source.

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

此外，还有大量示例:Ruby core和stdlib文档.例如，看一下File class中的一个类方法:

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:允许您用自己 Select 的文本替换方法名和参数，这对类方法非常有用.它还展示了如何通过缩进以单间距字体显示示例代码，类似于标记.

Ruby相关问答推荐

如何使用 define_method 指定方法默认参数？

如何在 OpenURI 中指定http 请求标头

在Ruby中将嵌套哈希键从CamelCase转换为snake_case

复制文件，在 Ruby 中根据需要创建目录

如何在 ruby 中编写负循环，例如 for(i=index; i >= 0; i --)

为什么 Matz Select 在 Ruby 中默认使字符串可变？

Ruby - 将块传递给方法

如何将消息附加到 RSpec 判断？

Ruby 2 中的命名参数

如何在Ruby中获取终端窗口的宽度

Ruby 设计模式：如何制作可扩展的工厂类？

Ruby注入初始为哈希

在Ruby中实现平等的正确方法是什么

文字数字中的下划线是什么意思？

使用 `？`(问号)在 Ruby 中获取 ASCII 字符代码失败

如何使用 link_to Ruby on rails 添加确认消息

Ruby 中的自然语言处理

使用 Liquid 标记在 Jekyll 中获取今天的日期

让 sidekiq 立即执行作业(job)

Ruby 类继承：什么是`<<`(双倍小于)？

实用课程推荐