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

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`。

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