悪い抽象化があなたのコードを手錠するのを防ぐ方法

良い比喩は重要です。 優れたメタファーに基づいた抽象化を見つけた場合、コードを理解するためにドキュメントを読んだり、ソースダイビングを行ったりする必要はほとんどありません。 思いついた比喩が優れているほど、システムを他の人に説明しやすくなり、後でシステムで作業しやすくなります。

どのようにして優れた比喩を思いつきますか？

優れた比喩は具体的で自己完結型であり、それが説明するものの鮮やかな精神的イメージを作成します。 誤解の余地はなく、コードの動作と可能な限り一致します。誰かが比喩の理解に基づいてコードについて仮定を立てる場合、それらの仮定は有効であるはずです。

良い比喩を思い付くのは難しいです。正しいメタファーを見つける前に、いくつかのリークのあるメタファーを経験することがよくありますが、それは問題ありません。 練習すれば簡単になります。 しかし、これが私を助けたプロセスです：

何について考えてください どのようにかを考えずに、少しコードを実行します。 それはそれをします。どんなイメージが思い浮かびますか？他のコードはそれをどのように使用しますか？それを一言か二言で説明しなければならないとしたら、どの言葉を使いますか？それを書き留めてください。

次に、そのイメージについて考えます。そのコードがどのように機能するかに適合しますか？比喩を通して漏れるエッジケースはありますか？ 他に何かありますか 新しい寄稿者がコードを使用する前に理解しなければならない比喩は？比喩について考えるとき、頭の中にはっきりとした絵が浮かびますか、それとも曖昧ですか？

これらは、メタファーがコードと十分に一致していないことを示す指標です。 しかし、良い比喩に近ければ近いほど、そこにたどり着くために必要な飛躍は少なくなります。

最後に、それを文の中で使用します。 「このコードはです （何か）、なぜなら…」技術的なバックグラウンドのない人にあなたの比喩を説明し、それが何をするのかを彼らに理解してもらえますか？誰かが比喩を理解するために必要な背景が少なければ少ないほど、あなたの比喩はより役に立ちます。

近くにいるが、完全にそこにいない場合は、シソーラスを調べてください。 類似した単語の微妙な違いは、OKの比喩と完璧な比喩の違いを意味する場合があります。