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

Question

在官方 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 的代码高亮语法，即相当于`foo`Markdown。

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