修正しやすいコードとは何かを言語化してみる

「修正しやすい」とはどういう状態か

Pythonを書いていると、よく聞く言葉があります。

「このコード、修正しやすいですね」

けれど、
何がどうなっていると「修正しやすい」のかを
はっきり説明できることは、意外と少ないものです。

この話では、
実務や実践を通して感じた
修正しやすさの正体 を整理してみます。

まず前提として、

は、同じではありません。

動くコードは、
「今の条件」を満たしているだけです。

修正しやすいコードは、
条件が変わることを前提にしている
という違いがあります。

これまで困ったコードを振り返ると、
共通点がありました。

コード自体が難しいというより、
意図が見えない 状態です。

逆に、修正しやすいコードには
いくつかの特徴があります。

たとえば、

def calculate_total(rows):
    return sum(int(r["value"]) for r in rows)

この関数は、

がはっきりしています。

修正しやすさは、
書き方の上手さではありません。

といった構造で決まります。

コメントを増やしても、
if文を工夫しても、
構造が曖昧だと修正は怖いままです。

「設計」と聞くと、
大げさに感じるかもしれません。

ですが、

を決めるだけでも、
それは立派な設計です。

修正しやすさは、
こうした 小さな判断の積み重ね で生まれます。

このテーマを振り返って分かったのは、

ということです。

この話は、
「修正しやすいコードとは何か」を
自分なりに言語化してみた記録です。

次からは、
この考え方を前提にして、

といったテーマを、
もう少し具体的に掘っていきます。