ruby - 如何防止 Yard 使用 @return 的内容作为描述？

Question

除了指定它输出的内容外，我没有什么有用的东西可以写这个函数。如果 Yard 没有找到描述，它会使用 @return 的内容。有什么办法可以防止这种情况发生吗？我想避免像您在下面的示例中看到的那样愚蠢的重复。

##
# @return [Array<Hash>]
#
#   an array of hashes. Example output:
#
#     [
#       {:name=>"FORNEBU", :municipality=>"BÆRUM", :county=>"AKERSHUS"},
#       {:name=>"FORSAND", :municipality=>"FORSAND", :county=>"ROGALAND"}
#     ]
#

Answer 1

你可以使用@example标签

##
# @return [Array<Hash>]
# @example
#   an array of hashes. Example output:
#
#     [
#       {:name=>"FORNEBU", :municipality=>"BÆRUM", :county=>"AKERSHUS"},
#       {:name=>"FORSAND", :municipality=>"FORSAND", :county=>"ROGALAND"}
#     ]
#

输出

方法描述如下:

#method_name(args) ⇒ Array<Hash>