在Ruby YARD docs中,将单词+;示例+;带有+;(加号)?

在Ruby YARD docs中,将单词+;示例+;带有+;(加号)?,ruby,yard,Ruby,Yard,在中,有以下示例: # @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] descri

在中,有以下示例:

# @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
有不同的含义吗?

它没有意义。事实上,YARD根本不关心标记,它只是将字符串未经处理地传递给输出生成器工具。(除了一些有限的例外,例如支持对模块、类和方法的引用。)

但是,它对SimpleMarkup/RDoc(它是一种输出处理器)确实有意义
+foo+
是RDoc用于代码高亮显示的语法,即它相当于Markdown中的
`foo`

因此,不同之处在于,
:foo
被呈现为“:foo”,而
+:foo+
被呈现为“
:foo
”,假设您使用SimpleMarkup/RDoc作为输出处理器。如果您使用Markdown作为输出处理器,它根本没有任何意义