Как документировать код Ruby?

Существуют ли определенные кодовые соглашения при документировании кода 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. Вы поместили свой комментарий в нужное место для этого, но вы должны взглянуть на документацию 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 . Это в значительной степени стандарт. Легко читать комментарии к коду, и это позволяет вам легко создавать веб-документацию для вашего проекта.

Я бы предложил познакомиться с RDoc, как указано. Но не стоит игнорировать и очень популярный инструмент YARD A Ruby Document . Много документации, которую вы увидите в Интернете, для Ruby использует Yard. RVM знает Yard и использует его для создания документации на вашем компьютере, если она доступна.

RDoc все еще будет необходим, поскольку Yard использует его.

У Rails есть некоторые Руководства по документации API . Это, вероятно, хорошая отправная точка.

Вы также можете проверить TomDoc для Ruby - версия 1.0.0-rc1.

http://tomdoc.org/

Канонический RDoc очень похож на тот, который вы опубликовали.

Смотрите пример раздела по ссылке, которую я вам отправил

Вот документация для системы документации ruby ​​(RDOC)