どういうプログラムを関数化をしたほうがいいのか しないほうがいいのか

質問

phpで、使いまわす可能性が高いコードを関数化しようか
迷っているんですが、関数化するとソースがどんどんカオス化していき
後から見て、ちゃんと管理ができるのかなあと不安になります。
他の人からみても分かるかどうかというのも問題です。
プログラムで、こういうソースコードを関数化したほうがいい
逆に、こういうコードは、直書きしたほうがいいというのがあれば
アドバイスお願いします。

回答No.2

hrm_mmm

＞関数化するとソースがどんどんカオス化
関数を作ったら、スパゲッティソースになるというのは、よっぽど変な作りかたしているとしか思えない。
まずは、メインの流れの中に関数定義は置かないこと。
同じファイル内なら、定義部分はソースの最後でよい。（トップダウン方式ともいう、私はもっぱらこの方が理解し易い）
考え方はいろいろあるので、先に関数定義をざっと並べておいて、最後にメインルーチンという方法もある。（ボトムアップ方式）
関数定義を別ファイルにする方が、メインルーチンでは、requireで読み込んだ後は、組み込み関数と同じ感覚で呼び出しすればいいので、よりすっきりする。

関数名の管理が、ごちゃごちゃする（かち合うと２重定義エラーになるし）というなら、命名規則を自分で作ってそれに沿って名付ける。
変数は、関数内でのみ使う局所変数は、他の関数で使っていてもなんの関係もないので、内部で、解りやすい命名をおこなう。
そのルーチンは一回しか使わなくても、変数の局在化の目的で関数にすることもある。

関数定義の別ファイルが大量に出来て、ファイル群がカオス化すると言う意味なら、ファイル名も命名規則で見分けやすくするとか用途別にディレクトリ分けするとか。

読む方の読みやすさというのは、つまり、数ヵ月後その中身を忘れた頃に自分が読んで直ぐに理解できるかってあたりで判断してもよいかとおもいます。
ということで、私は、コメントは残しておく方です。

例 トップダウン方式
// // main routine
$s = start_func();
if( $s ){
$a = syori_1($s);
}else{
$a = syori_2($s);
}
print_body($s,$a);
end_func();
// // 以下定義
/*
この定義の並べる順番は、phpにとっては、どうでもよいが、読む方にとっては、実行順の方が理解しやすいだろう。
*/
function start_func(){
$res = true;
$res = header_else($res); // header 関係操作とか いろいろ実行
return $res;
}
// 関数の内容表題　引数の意味、返値の意味などコメントしておくとよい
// 引数($s : startの返値);
// return string
function syori_1($s){
$res = 'performed'; // いろいろ実行
return $res;
}
// ...略...
// end //

お礼

回答ありがとうございます。
トップダウン方式で書いてみたところ、
関数系プログラムが一番下に固まるので大変見やすくなりました。
直書きから、インクルードに切り替える時も
一番下に固まってるので大変取り出しやすいです。

ファイル名のつけ方も惜しみなく長い名前にしたほうがよさそうですね。
エンコード変換関数とかでsjis to eucを　s2e　とかする人いますが、
一見なにやら、よくわからないですものね。

ありがとうございました。