如何loggingRuby代码？

loggingruby代码时是否存在某些代码约定？ 例如，我有以下代码片段：

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 

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

Answer 1

你应该针对RDoc处理器的文档，它可以find你的文档并从中生成HTML。 你已经把你的评论放在了正确的位置，但是你应该看一下RDoc文档来了解RDoc知道如何格式化的标签types。 为此，我会重新格式化您的评论如下：

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

Answer 2

我会强烈build议使用RDoc 。 这几乎是标准。 阅读代码注释非常简单，它可以让您轻松地为您的项目创build基于Web的文档。

Answer 3

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

Answer 4

我会build议逐步了解RDoc。 但是不要忽视非常受欢迎的YARD Ruby文档工具。 您将在网上看到的很多文档使用Yard。 RVM知道Yard，如果可用的话，使用它在您的机器上生成文档。

由于Yard使用它，RDoc仍然是必需的。

Answer 5

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

http://tomdoc.org/

Answer 6

规范是RDoc它和你发布的非常相似。

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

Answer 7

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