如何强制逐字模式在rdoc中包含文件

时间:2013-12-04 17:14:50

标签: ruby rdoc

我需要在我的rdoc中包含一个示例程序。这个例子 程序也需要可执行,以便用户可以运行 命令行中的示例。

我希望完全按照编写的方式显示程序的源代码 我的rdoc格式化文档。

从我所看到的,触发逐字模式的唯一方法是增加 缩进级别。

那么,如何让我的文件“包含”示例程序,但标记 它以任何方式?

我试过了:

# :include:example_program.rb

但它将example_program.rb的内容作为非逐字处理,直到它到达第一个 缩进代码块。

然后,它将的块的主体视为逐字,然后是块 结束,回到解释标记。

我希望它不会在整个持续时间内解释任何标记 包含文件。

是否有其他方式来描述逐字部分而不是缩进?

1 个答案:

答案 0 :(得分:1)

我明白了。

我需要缩进include指令本身:

#!/usr/bin/env ruby
#   :incude:sample_program.rb
# Other commentary that I wish to be marked up by rdoc.

我一直假设逐字块中的include指令会 本身是逐字输出的。

显然,如果逐字块只包含一个include指令,那么 处理完全是我的问题的解决方案。