Ruby Yard Doc：预格式化代码

Question

我一直在尝试让 yard doc 输出预格式化的代码。我试过 @example 但没有解析。 ++code++:: 将创建一个代码部分，但不会保留格式。

我使用的是默认设置，所以我假设是 RDoc。 yard 版本：yard 0.8.7.6, Ruby 版本：ruby 1.9.3p484 (2013-11-22 revision 43786) [x86_64-linux]

这是评论部分：

# == Example
#       emitter = AsyncEmitter.new
#       emitter.on :error, lambda { |e| puts "Error: #{e}" }
#       emitter.on :data, lambda { |data| puts "Data: #{data}" }
#
#       begin
#               data = get_data_from_somewhere
#               emitter.emit :data, data
#       rescue Exception => e
#               emitter.emit :error, e
#       end

Answer 1

如果这是目标：

这是文件创建时的样子：

# Example
#     emitter = AsyncEmitter.new
#     emitter.on :error, lambda { |e| puts "Error: #{e}" }
#     emitter.on :data, lambda { |data| puts "Data: #{data}" }
class AsyncEmitter

# Description and example
#     begin
#       data = get_data_from_somewhere
#       emitter.emit :data, data
#     rescue Exception => e
#       emitter.emit :error, e
#     end
  def get_data_from_somewhere
    # Your Code Here
  end
end

我使用 Bundler 来设置环境，这是 Gemfile 的内容：

source "https://rubygems.org"
ruby '1.9.3'
gem 'yard', '0.8.7.6'
gem 'redcarpet'

我使用了 4 个空格来缩进，而不是制表符。而且我确保空白行也包含 4 个空格。

Ruby Yard Doc：预格式化代码

Ruby Yard Doc: preformatted code

ruby

yard