■anond:20231216154938

コードの重複があるわけでもない状況で、コードを関数ごとに分離するメリットデメリットを知りたいという話ですよね。

コードの重複がある場合に関数などに切り分けていないと、同じコードを何度も書くことになり、不具合があった時にコピーされたすべての個所に変更が必要となるというデメリットがあるので理由がわかりやすいですが、重複が無いとその点が不明確ですね。

画面に収まらないサイズのコードは複数の関数に分割するのが一般的だとは思います。

理由は元増田も書かれている通り、長いと理解の限度を超えるからです。

コードは意味があるまとまりで短ければ短いほど理解がしやすいと思います。

グローバル変数を使わないようにすると、入力・出力が関数を読むだけで明確にわかるので、さらに理解がしやすいです。

また、関数に分けておけば、関数が仕様通りに動くかの確認するユニットテストも簡単に書けます。

ユニットテストでは関数がさらにほかの関数を呼び出している場合、呼び出される関数の代わりにテストダブルを用意することもあります。

分割して、複数の関数を呼び出すようにすることのデメリットは、

下手糞が切り分けるとなんでそういう切り分けになったかわからないところで切り分けられてかえって可読性が損なわれるとか、

関数の機能が拡張してより多く・あるいは少なくの情報が必要な時に関数インタフェースの変更が必要になることとか、

関数を置いているファイル内の場所を変えたときにバージョン管理システムが追っかけてくれないことがあるとか

くらいでしょうか。

いずれにせよ、分割するメリットの方がデメリットを上回ることが大半なので、大抵は機能ごとに分割して小さい関数を作り、それをメインからは呼ぶようにすると思います。

以下、お悩みポイントに答えます。

一番はメイン/サブ関数間で右往左往するので今やってる工程が何なのかがよくわからん

まず、関数の名前をやっている工程を表すものにすることですね。

「データの取り込み」 とか 「データの突合せ」とかを明示すると、それを呼んでいるということはそういうことをしてくれると思うので。

また、関数が何をしてくれるのかも関数のコメントとしてつけておくとよいと思います。

例えば、

filename引数で指定されたファイルからデータを取り込み、JSONフォーマットで返す

引数: filename

返値: JSONフォーマットされた取り込まれたデータ。例: [{'employee name': '山田 太郎', 'employee id': 1}]

例外: filenameを開けない場合はFileOpenError、JSONにコンバートできなかった場合はConvertError

みたいなコメントをつけておくと何をする関数なのかわかるので、その機能を調べたいとき以外は読まないでいいかなと。

あと、コードを連続で読みたい場合、ソースを解析してタグジャンプをつけてくれるツールやらIDEやらを使うことが普通だと思います。

あとは関数ごとに変数をいちいち定義し直すのがだるいみたいなのもありますね。

これはどういう意味でしょうか？同じものを表すのに関数ごとに別の変数名を付けているとか？

もしそうだとしたら、使っているプログラミング言語の制約やプログラミング規約によるものなのでしょうか？

ある関数のローカル変数が他の関数のローカル変数に影響を与えることは無いはずなので、ローカル変数は大抵適当な名前が付けられるイメージです。

今時のプログラミング言語なら変数のスコープが関数の中にとどまるような書き方ができると思うのですが。

関数インタフェースを定義し、そこにいちいち引数を書くのが面倒というなら...まあ、それは必要税って感じがします。

そこに引数を書いておくことでこの関数が何に影響されるのかわかるので。

参考までに。

Permalink | 記事への反応(0) | 09:42

ツイートシェア