在 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 作为输出处理器，那根本就没有任何意义。

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

In Ruby YARD docs, what it mean to wrap a word +example+ with + (plus sign)?

ruby

yard