書いたプログラムをレビューしてもらった。 vol.2

プログラミング全般

依存、マジックナンバーについてレビューで指摘をいただいた話になります。

依存

関数を作る際に、依存にあまり意識しないでどんどん作っていっていました。

「依存の少ない関数=修正がしやすい」というわけですが、僕はそれをフル無視していました。修正がやりやすいとは、一つの機能を直すのに修正箇所が少ないことがあげれれると思います。

関数において他との依存が高い状態はあまり望ましくありません。

引数でできるだけ数値を渡したり、そんなことすらあまりうまくできていなかったわけです。

マジックナンバー

あとは、マジックナンバーについての指摘もありました。

マジックナンバーとは、プログラムの中にある数字の事を指します。そして、その数字だけ見ると何の数字か分からないわけですね。

ということはマジックナンバーは使わない方が良いということです。

例えば、2021というマジックナンバーがあれば、thisYearという定数に代入する。というような作業が必要となります。

僕はこちらもフル無視していたわけで、初めのプログラムにはマジックナンバーであふれていました。一人でプログラムを書く分には問題はありませんが(実際ある)、人が増えると問題だらけですよね。

プログラムの可読性がすごく低くなるんです。

なおかつ、その数字が変わった時にはthisYearという定数を使っていると、その定数を一つ変更するだけで大丈夫というわけです。

2021というマジックナンバーをプログラム内で多用していると変更箇所は増えて、修正が非常に大変になる可能性も出てきますね。

そういった理由からマジックナンバーは避けたほうがいいのです。

そんなルールは無視をしてはいけないのです。

まとめ

個人でやっていると頭の中である程度理解しているので、あまり問題には気が付きにくいです。しかし、他人に見てもらうことでプログラムの問題に気が付くことがあるわけです。

関数の依存、マジックナンバー、他にもたくさんの指摘をいただいたのでこれからプログラムを書く際には意識していきたいです。

客観的な意見の大切さを学べます。

コメント

タイトルとURLをコピーしました