首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何记录Ruby代码?

如何记录Ruby代码?
EN

Stack Overflow用户
提问于 2009-11-05 23:54:53
回答 6查看 91.8K关注 0票数 214

在编写ruby代码文档时,是否有特定的代码约定?例如,我有以下代码片段:

代码语言:javascript
复制
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

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

EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/1681467

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档