如何记录Ruby代码？

在记录红宝石代码时是否有某些代码约定？例如，我有以下代码片段：

require 'open3'

module ProcessUtils

  # Runs a subprocess and applies handlers for stdout and stderr
  # Params:
  # - command: command line string to be executed by the system
  # - outhandler: proc object that takes a pipe object as first and only param (may be nil)
  # - errhandler: proc object that takes a pipe object as first and only param (may be nil)
  def execute_and_handle(command, outhandler, errhandler)
    Open3.popen3(command) do |_, stdout, stderr|
      if (outhandler)
        outhandler.call(stdout)
      end
      if (errhandler)
        errhandler.call(stderr)
      end
    end
  end
end

这种猜测是可以的，但是也许有更好/更好的文档实践？

您应该将文档定位于RDoc处理器，RDoc处理器可以找到您的文档并从中生成HTML。您已经在正确的位置添加了注释，但是您应该查看RDoc文档以了解RDoc知道如何格式化的标记类型。为此，我将重新格式化您的评论，如下所示：

  # Runs a subprocess and applies handlers for stdout and stderr
  # Params:
  # +command+:: command line string to be executed by the system
  # +outhandler+:: +Proc+ object that takes a pipe object as first and only param (may be nil)
  # +errhandler+:: +Proc+ object that takes a pipe object as first and only param (may be nil)

我强烈建议使用RDoc。这几乎是标准。阅读代码注释很容易，它使您可以轻松地为项目创建基于Web的文档。

我建议按照所述了解RDoc。但是，也不要忽略非常流行的YARD A Ruby Document工具。您会在网上看到的很多关于Ruby的文档都使用Yard。RVM知道Yard并将其用于在计算机上生成文档（如果有）。

由于Yard使用RDoc，因此仍然需要RDoc。

Rails有一些API文档指南。那可能是一个很好的起点。

您也可以检查TomDoc for Ruby-版本1.0.0-rc1。

http://tomdoc.org/

规范的是 RDoc，它与您发布的非常相似。

请参阅我发送给您的链接上的示例部分

这是ruby文档系统（RDOC）的文档