如何为方法别名指定“@since”?

hwazgwia  于 2021-09-29  发布在  Java
关注(0)|答案(1)|浏览(288)

我正在写一本Ruby。为了记录我的代码,我使用yard。我一直在使用 @since (参见此处)标记添加了哪些gem版本方法。然而,我有一个问题。在我的gem的一个版本中,我定义了一个方法。现在,在gem的新版本中,我想为该方法定义一个别名。对于码/rdoc,我如何添加 @sincealias ?
我试过这个,但没用:


# ...

# @since 1.0.0

def my_method
  # ...
end

# @since 1.1.0

alias new_method my_method

有什么想法吗?

l0oc07j2

l0oc07j21#

您应该能够使用 @!method 实现这一目标的指令:


# @since 1.0.0

def my_method
  # ...
end

# @!method new_method

# @since 1.1.0

alias new_method my_method

相关问题