在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作爲輸出處理器，那麼它根本就沒有任何意義。