如何为方法别名指定`@since`？

问题描述

我正在编写一个 Ruby gem。为了记录我的代码，我使用了 YARD。我一直在使用 @since（参见 here）来标记添加了哪些 gem 版本方法。但是，我遇到了问题。在我的 gem 的一个版本中，我定义了一种方法。现在，在新版本的 gem 中，我想为该方法定义一个别名。如何使用 YARD/RDoc 将 @since 添加到 alias？

我试过了，没用：

# ...
# @since 1.0.0
def my_method
  # ...
end
# @since 1.1.0
alias new_method my_method

有什么想法吗？

解决方法

您应该能够使用 @!method 指令来完成此操作：

# @since 1.0.0
def my_method
  # ...
end

# @!method new_method
#   @since 1.1.0
alias new_method my_method