綺麗なコードについて学ぶ
コードを書く事がこの先もっと多くなりそうなので、早いうちに他の人がちゃんとすぐ分かるように綺麗なコードの書き方について、エンジニア先輩方のqiitaの記事から引用して学びます。
...
分かりやすい名前をつける
まず、一つの変数を宣言してみる
var n;
これだけでは「これは何を格納している変数なんだ?」ってなって、いちいち全コードを見返さなくてはならない。
(for(orderCount=0;orderCount<0;orderCount++){};のようにするより、
for(n=0;n<0;n++){}; の方が分かりやすい場合もある。)
例えばこれが本を格納する変数だとすると
var book;
とすると一発で本を格納する変数だと分かる。
さらにいうと、これがどういった本なのかわかればなお良い。
var readableBook;
これだとこの変数は読む事ができる本を格納するものだと分かる。
メソッドの場合
何かに何かをするメソッドだと、動詞と名前を絶対入れるようにすると良い。
また
分かりやすくしようと意識して長くなってしまったりするけど、長すぎてもだめ。
var reservationAvailableBook;
予約可能な本を格納する変数だと分かるが、変数名が読みづらいからイライラする。
他の人に見せるので、思いやりのあるネーミングを心がける。
よく使う単語や使わない方が良い単語は下記のサイトを見て学ぼう
...
短くブロックする。
あるメソッドにデータベースからある本を取得したいメソッドを書く場合
function getBook(data){ //DBから本を取得する処理 ... //取得した本の名前をターミナルに出力する処理 }
とすると「本を取得するメソッドなのにそれ以外になんか余計な事してやがる」ってなっちゃう。
なのでコーディングしなおすと
function getBook(data){ //DBから本を取得する処理 } function outputBookName(data){ //取得した本をターミナルに出力する処理 }
とするのが良い。短くブロックすると仕様変更に強く書き換えやすい
...
他にもいろいろありすぎて一冊の分厚い本になりそうなので、ちゃんとまとめてくれてる記事を下記に貼っておく
綺麗なコードは永遠の課題となりそう...がんばろ....