How To Write “Good Legacy Code”
良いレガシーコードを書くための簡単な出発点をいくつか紹介します。 コードは読むよりも書く方がはるかに簡単であり、問題を修正する最善の方法は、問題を作らないことです。
Write less code
Less code = less potential for bugs = less to maintain = less “bad legacy”.
Writing less code is seen as the single most important way to improve code in general.これは、一般的に、コードを改善する最も重要な方法と考えられます。
Avoid // TODO and // FIXME
// TODOまたは// FIXMEを書くことは、赤旗およびコード臭とみなすべきです。
これらのコメントを実際の意味に翻訳すると、「TODO」は「技術負債を作る」、「FIXME」は「私は故意にバグを書いています」と翻訳されることになります。
There may be rare exceptions where deferring a solution outweigh the benefits of resolving it now, but generally, TODO and FIXME should be kept to a minimum.
Prefer established idioms over the cutting edge
This may seem contradictally… using bleeding-edge technologies makes code more “new”, right?
また、新しいプログラマが物事を理解するのに苦労することになります。
Always leave the code in a better state than you found it
これは、冒頭で述べた「書き直さない」と矛盾するように思えるかもしれませんが、継続的な改善とリファクタリングは、大幅な書き直しをすることとは異なります。
Keep improving as a programmer
Read books, read blog posts, read other people’s code, think carefully about design and programming practices.プログラマーとして向上し続けること。 意識的に自分のコードを振り返り、改善する方法を考える。
悪い遺産を残した前のプログラマを非難するのではなく、新しい遺産を作るプログラマにならないようにする。