ruby - 我如何在 RDoc 中表示方括号 ([])？

Question

我正在尝试记录我在类里面使用 RDoc 注释编写的一些 rake 任务，但在表示方括号时遇到了麻烦。我想添加一些示例，说明如何使用参数运行我的 rake 任务，因此有一个像这样的 rdoc 行:

# 例如。 rake 构建[MyProject]

问题是 RDoc 解析器转换创建了一个链接而不是打印方括号。我尝试了各种转义序列:[ ; [[; ＃{[我的项目]} ; [我的项目]但似乎没有任何效果。

有什么方法可以转义这些方括号，使它们不会转换为链接吗？

谢谢，亚伦

Answer 1

通过进一步的实验，我发现了一种方法。如果我在每行前面放置两个空格，RDoc 会将这行视为预先格式化的文本并呈现括号。对我来说足够好了。

生成的 RDoc 行是:

#  eg. rake build[MyProject]