Rails自定义弃用通知

在Rails 3中,您可以使用: "deprecate" method from ActiveSupport :

class Example
  def foo
  end

  deprecate :foo
end

它将为您的方法创建别名,并输出带有堆栈跟踪的警告。您也可以直接使用此功能的某些部分,例如:

ActiveSupport::Deprecation.warn("Message")

也许 吧:

def old_relationship
  warn "[DEPRECATION] old_relationship is deprecated."
  @old_relationship
end

def old_relationship=(object)
  warn "[DEPRECATION] old_relationship is deprecated."
  @old_relationship = object
end

为了一段关系而做的事情。

在大多数情况下,您可以发出警告并调用新方法。

class Example
  # <b>DEPRECATED:</b> Please use <tt>good_method</tt> instead.
  def bad_method
    warn "`bad_method` is deprecated. Use `good_method` instead."
    good_method
  end

  def good_method
    # ...
  end
end

Yard 而不是 rdoc

# @deprecated Please use {#useful} instead

最后,如果你坚持 tomdoc ,使您的评论如下所示:

# Deprecated: Please use `useful` instead