在Ruby YARD文档中，用+（加号）包装单词+ example +是什么意思？

Question

在official YARD docs中，有以下示例：

# @overload set(key, value)
#   Sets a value on key
#   @param key [Symbol] describe key param
#   @param value [Object] describe value param
# @overload set(value)
#   Sets a value on the default key +:foo+
#   @param value [Object] describe value param
def set(*args) end

+:foo+在+两侧包裹时有什么特殊含义？ +:foo+具有与:foo不同的含义吗？

Answer 1

对YARD没有意义。实际上，YARD并不关心标记，它只是将字符串传递给未经处理的输出生成器工具。 （有一些有限的例外，例如支持对模块，类，方法的引用。）

然而， 对SimpleMarkup / RDoc（YARD支持的输出处理器之一）有意义。 +foo+是RDoc的代码突出显示语法，即它相当于Markdown中的`foo`。

所以区别在于:foo呈现为“：foo”，而+:foo+呈现为“:foo”，假设您使用SimpleMarkup / RDoc作为输出处理器。如果你使用Markdown作为输出处理器，它根本就没有任何意义。