web-dev-qa-db-ja.com

「まだ実装されていない」ことを知らせる方法

新しいgemの最初のドラフトでは、いくつかのメソッド実装を空のままにする必要があります(次の実装で実装するため)

したがって、「未実装」の例外を通知したいと思います

ベストプラクティスまたは標準的な慣習固有のものがあるかどうか疑問に思っていますRuby言語にこの種のプレースホルダー/例外をコーディングします。

すなわち:のようなもの:

58
Franco Rondini

NotImplementedErrorを発生させる必要があります

raise NotImplementedError

Ruby-doc

27
pasha.zhukov

todonotes-gem を使用できます

ドキュメント がいくつかの例とともにあります。

例外は実装しませんが、ロギングメカニズムと一時的な解決策の可能性を実装します。

4
knut

NotImplementedErrorを上げることを提案した元の回答は削除されたようです。私はそれをクラックします:ドキュメントを書きます。

単なるプレースホルダーであるコードを追加しないでください。そのAPIに対してコーディングする人が欲しくないので、チャンスさえ与えないでください(あなた自身が含まれます)。代わりに、現在計画しているロードマップをクラスまたはREADMEで文書化します。その後、変化にオープンになります。オッズは、ロードマップにある問題を解決するまでに、適切な解決策が何であるかについて新たな考えを持つようになるまでです。これはどの言語/フレームワークでも正しい行動方針だと思いますが、特にRubyは、実行する予定のないコードを書かないように勧めています。

2
Chris