関数の中身なんてどうでもいい

Webアプリの開発実務を5年ほど続けると考えることが昔と逆転してきた。
その1つは関数の中身よりもドキュメントの方が大切だということ。

関数を理解する時、 それが何をする関数なのか、何を入れると何を戻してくれるのか。 が書かれていて欲しいと常々思う。
関数ドキュメントが書かれていないと毎回関数の中身を読む手間が発生するからだ。

例えば台所に塩を置くならビンに「塩」と書いて欲しい。

棚に並んだ白い粉の入ったビンだけの存在だと、それが塩か砂糖か味の素かわからない。
おにぎりに塩を振りたい時に塩を見つけるために味見をする必要がある。
棚掃除の時に手に取ったものが何かを知るために味見をする必要がある。
塩を追加で購入したから中身の補充をしたい時に塩を見つけるために味見をする必要がある。

味見をしなくても塩だとわかればどんなに楽なことか。

ビンに塩を詰めた本人は記憶が鮮明で手に取っているそれが当然塩だと思っているから「塩」と書く必要性に気付かない。
塩の中身が天然塩か精製塩か国産か減塩かを気にするのも大切だが、それよりも塩を入れているビンに「塩」と書くことの方が大切だ。
関数の中身にこだわることも大切だが、関数ドキュメントを書くことの方が大切だ。

プログラムは往々にして作った後は管理される対象となるから関数ドキュメントを書くことで管理しやすくなるという恩恵がある。
そして関数の使用効率を上げることよりも管理効率を上げることの方が恩恵が大きいと思う。

だから関数の中身なんてどうでもいい。