Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/.net/21.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Ruby 对于正确的RDoc语法是否有一个好的、可靠的参考?_Ruby_Rdoc - Fatal编程技术网

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

Ruby 对于正确的RDoc语法是否有一个好的、可靠的参考?,ruby,rdoc,Ruby,Rdoc,我正在为正确的RDoc语法寻找一个好的、可靠的参考。建议?我似乎找不到任何东西清楚地表明: 如何记录类方法及其参数 如何记录类或类方法的功能 可以找到一个正式的rdoc示例,其中包含它的 上的文档似乎比上的版本更完整(顺便说一句,上的版本有2003年的修改日期) 此外,还有大量示例:Ruby核心和stdlib文档。例如,请查看以下目录中的一个类方法: File.atime(文件名)=>time 返回该文件的上次访问时间 将文件命名为时间对象) File.atime(“testfile”)#=>W

我正在为正确的RDoc语法寻找一个好的、可靠的参考。建议?我似乎找不到任何东西清楚地表明:

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

  • 可以找到一个正式的rdoc示例,其中包含它的

    上的文档似乎比上的版本更完整(顺便说一句,上的版本有2003年的修改日期)

    此外,还有大量示例:Ruby核心和stdlib文档。例如,请查看以下目录中的一个类方法:

    File.atime(文件名)=>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:
    允许您将方法名称和参数替换为您选择的文本,这对于类方法非常有用。它还显示了如何通过缩进以单间距字体显示示例代码,类似于标记。

    因为,这里有一个新链接:


    我只是在找这个。请注意,它有(看起来)官方规范。搜索:RDoc标记参考该死!我真的应该阅读第二条注释,不确定这是否也适用于较新的版本,但在我的1.9.3 ruby中,它似乎不支持
    --markup
    选项(试图使用提到的-我遗漏了什么吗?rubyforge链接已失效。是此页面上唯一可用的链接。请编辑您的答案以使用该链接?我无法找到答案中提到的源代码链接(该链接表示通过“单击第一行”访问)(在实际RDoc页面中,而不是在我在本答案中包含的报价中)这是指向新版本的链接。这一个看起来也很流行:旧的链接在新版本中已经失效了。流行:这很荒谬。所有ruby文档链接都失效了,但这似乎可以正常工作:但是要多久…?这个页面只包含处理方法参数的最神秘的文档,而没有关于返回类型、异常等的内容。非常有趣很难理解。