我一直在努力让院子文档输出预先格式化的代码。我试过@example但是没有解析。 ++ code ++ ::将创建一个代码段,但不保留格式。
我正在使用默认设置,所以我假设RDoc。院子版:码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
答案 0 :(得分: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个空格。