Ruby Yard Doc：预格式化代码答案

【问题标题】：Ruby Yard Doc: preformatted codeRuby Yard Doc：预格式化代码
【发布时间】：2015-04-26 18:21:30
【问题描述】：

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

我使用的是默认设置，所以我假设是 RDoc。 Yard 版本：yard 0.8.7.6，Ruby 版本：ruby 1.9.3p484（2013-11-22 修订版 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

【问题讨论】：

您使用的是制表符还是空格？
对于缩进？标签。
'请注意，您刚刚安装了一个不再维护的 ruby (2014-02-23)'，因为我正在安装这个 Ruby 来查看这个问题。
谢谢。它仍然是 debian 默认的 pkg。
希望您能接受答案。很高兴您找到了解决方案。

标签： ruby yard

【解决方案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 个空格。

【讨论】：

对于那一点恼人的部分，只需在“描述和示例”之后添加一个换行符，这将作为“摘要”
就是这样。空格不是制表符。谢谢。