如何防止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>