在Ruby YARD文档中弃用重命名的属性

在Ruby YARD文档中弃用重命名的属性,ruby,deprecated,yard,Ruby,Deprecated,Yard,我已经在我的Ruby中重命名了一些属性,以匹配新的属性。为此,我重命名了属性,然后使用alias_方法确保旧方法仍然有效 以下是我为重命名属性所做的一个示例: # The level number of the protocol attr_accessor :protocol_level # @deprecated Please use {#protocol_level} instead alias_method :protocol_version, :protocol_level # @d

我已经在我的Ruby中重命名了一些属性,以匹配新的属性。为此,我重命名了属性,然后使用alias_方法确保旧方法仍然有效

以下是我为重命名属性所做的一个示例:

# The level number of the protocol
attr_accessor :protocol_level

# @deprecated Please use {#protocol_level} instead
alias_method :protocol_version, :protocol_level

# @deprecated Please use {#protocol_level=} instead
alias_method :protocol_version=, :protocol_level=
然而,在生成的YARD文档中,它并没有将其标记为不推荐的名称,实际上使其看起来像是一个很好的替代名称

- (Object) protocol_level
Also known as: protocol_version
The level number of the protocol
最好的方法是什么?我应该改用普通方法定义旧的属性名吗?我非常希望代码简洁。

从外观上看,您应该将方法标记为已弃用。差不多

# @deprecated Use {#bar} instead.
def foo
  bar
end

def bar
  ...
end

我意识到这并不像使用
alias\u方法那样简洁,但我认为这是使用YARD的唯一方法。

同意似乎没有更好的方法。