この記事では具体的なコードについては触れません。
コードを書いていくのに使える原則について紹介します。
また、この記事では「プリンシプル オブ プログラミング」という本を読んだ上で、
自分が特に重要と思った箇所を、備忘録も兼ねて、書いています。
PIEとは
まず始めに、PIEを文章に直すと「Program Intently and Expressively」となり、
訳すと「意図を表現してプログラミングせよ。」という意味になります。
意図を表現してと言われてもどういうことかあまりわからないですよね。
なのでこの原則を簡単に以下にまとめてみました。
PIEの原則
コードを書く時に大切なことは「このソフトウェアはどう動くものなのか」
ということを、コードの読み手に伝わるように書きなさいという原則です。
なんで？
わざわざコードでとやかく言われるより、その時にドキュメントにまとめてれば良いのでは？と考える人も中にはいるかもしれませんが、
どんなに、様々な種類のドキュメントが作られたとしても、
ソフトウェアの動作を正確に、完全に、知ることのできるものはコード以外に存在しないということです。
コードは読みやすさを最優先に！
コード書くときは、「書きやすさ」よりも「読みやすさ」を選ぶようにしましょう！
コードは、基本的に書かれることよりも、読まれることの方がはるかに多いです。
書くのは1回ですが、その後たくさんの人が、たくさんの回数読むことになります。
そうなると結果的に、
「書いていた時間」 ＜ 「読まれる時間」
となり、長期的な目で見ても読みやすく書いておく方が、断然、お得なのです！
読みやすくする方法
コードは言語によって様々な記法になりますが、
共通で使える読みやすくする方法の一つに、「コメントを入れる」という方法があります。
コメントがなくてもわかるレベルで読みやすいのが理想ですが、
コードだけでは「What」と「How」までしか表現できないのも確かです。
なので、コメントでは見ればわかる、「What」と「How」よりも、
なぜそうしたのかといった「Why」を意識して書くようにしましょう。
そうすれば読みやすいコードに一歩近づくはずです。
まとめ
コードはPIEの原則に従い、読みやすさを最優先に実装しましょう！