ソースコード中には様々な単位が出てきます。変数や定数、クラス、関数などですね。
これらのソースコード量は基本的に小さくしていかなければなりません。
では、なぜ大きいとだめなのか、小さくするにはどうしたら良いのかを説明していきたいと思います。
目次
なぜ大きいとだめなのか
結論としては、処理を把握することに時間がかかるからです。 ソースコードを読むことにおいても、修正や試験を行うことにおいても時間がかかるようになってしまいます。
例えば、勉強を行う際に参考書で「ある公式」を調べようとします。目次や索引がない場合、どのあたりに調べたいものがあるのか、調べるのに時間がかかってしまわないでしょうか?
更に関連する公式に対するページ数も説明されていると親切に感じるのではないでしょうか?
こんな参考書が見やすい参考書で、ついつい手に取りたくなりませんか?
「ある公式」が書いてあるのは1ページ程度に小さくまとまっていて、
それを呼び出す目次や索引は別ページに小さくまとまっている。
関連する公式についても小さくまとまっているから、「関連公式」のページを見るだけでOK。
プログラミングも同様です。
「ある処理」は一つの関数に小さくまとまっていて、
それを呼び出す関数も、小さくまとまっている。
関連する処理については、同じクラスにまとめてあるから、「クラス」を見るだけでOK。
このように、何かを相手に伝えることを目標とした場合、小さくまとめておくことがとても重要になるのです。
ちいさくまとめるには?
小さくまとめるにはやりたいことを把握することが重要です。 参考書を例にして説明させていただきましたが、「相手に伝える」「わかりやすいソースコードを書く」には、言語の知識、業務の知識をしっかりと把握することが必要になります。
どこまで把握すればよいかについては、相手がわかるように説明できるかがポイントになるかと思います。
相手は誰でどんな目次を作っておいて、どんな順番で説明すれば、伝わるのだろうか。ここを意識するようにすれば知識の把握はできてくると思います。
言葉で説明する文章を先に作ってからソースコードに落とし込むのも良いかもしれません。
得られた知識から関数やクラスに落とし込んでいく際には、一言で説明できるか を意識して関数分けをしていくとよいでしょう。
まとめ
ソースコードが大きいと、把握に時間がかかってしまい、修正や試験に時間がかかるようになる。
ソースコードを小さく保つには、やりたいことをわかりやすく一言で説明することが重要になる。
このことを意識してソースコードは書いていくようにしましょう。