代码之家 › 专栏 › 技术社区 › Bill Mei

在Ruby YARD docs中,用+(加号)包装单词+示例+意味着什么?

yard ruby

5

Bill Mei · 技术社区 · 8 年前

# @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 ?

1 回复 | 直到 8 年前

1

6

Jörg W Mittag 8 年前

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

它做然而,对SimpleMarkup/RDoc(这是工厂支持的输出处理器之一)有意义。 +foo+ 是RDoc用于代码高亮显示的语法,即它等效于 `foo` 在降价中。

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