如何记录 Ruby 代码

发布于11月06日

在记录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处理器，它可以找到您的文档并从中生成HTML.你已经把你的 comments 放在了正确的地方，但是你应该看看RDoc documentation个标签，了解RDoc知道如何格式化标签的种类.为此，我将你的 comments 改写如下:

  # 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)