Ruby で非推奨のコードをマークするためのベストプラクティスは? 質問する

Question

ほとんどの場合、非推奨をライブラリやメタプログラミングに依存するのはやりすぎです。rdoc にコメントを追加してメソッドを呼び出すだけですKernel#warn。例:

class Foo
  # <b>DEPRECATED:</b> Please use <tt>useful</tt> instead.
  def useless
    warn "[DEPRECATION] `useless` is deprecated. Please use `useful` instead."
    useful
  end

  def useful
    # ...
  end
end

使用している場合ヤードの代わりにドキュメントドキュメントコメントは次のようになります。

# @deprecated Please use {#useful} instead

最後に、トムドックコメントは次のようになります:

# Deprecated: Please use `useful` instead

非推奨: メソッドが非推奨であり、将来のバージョンで削除されることを示します。パブリックであったが次のメジャーバージョンで削除されるメソッドを文書化するには、これを使用する必要があります。

また、将来的には非推奨のメソッドを削除することを忘れないでください（そして適切にセムバー'd) リリースJava ライブラリが犯したのと同じ間違いをしないでください。

Answer 1