読みやすいコード

良いコードとは何か？

①命名規則がしっかりしている
②コードのレイアウト
③コメントがある
だと考えています！
変わったら変更します。

そもそもなんでいいコードが必要なの？

コードを書くのは大規模なプロジェクトになればなるほど、一人ではなく、チームで行うことが多くなるかと思います。僕は、最初はフリーではなく企業内でのエンジニアを目指しているのでこの点すごく気にしています。
みんな、生まれも育ちも違うので、もちろん英語力等も違うと思いますので変数の名前を自分のつけたいようにつけていては、チームメンバーが後から読んだ時になんやこれ！？となることを防げるのがいいコードなのかな。。。？という感じです。
俺は一匹狼なんだなんていう人も、後からエラーが出た時に無茶苦茶にその時の気分で変数をつけていると後からなんだこれ？となることも想定されるのでいいコード（統一感のもった）をかけるスキルは必要なのではないでしょうか？

①命名規則

変数やメソッドの名前はプログラムの挙動に影響しないため、好きなように命名することができます。変数であれば、どのようなデータを格納するのか、メソッドであれば、どのような処理をするのかを明確に伝えられるような命名をしたいです。
-明確で具体的な単語を選ぶ（getではなくget_pageとか）
-汎用的な名前は避ける（合計値を一時的に保持したいならtmpではなくsumとか）
-名前に情報を含める（その変数は何をしているのかを明確に記載する）
-誤解されない名前を使う（read_bookではなくalredy_read_bookとか）
-他の開発者の期待に応える（変なところでnilを使わないとか）

②コードのレイアウト

-整列化
-一貫性
-ブロック化

整列化

イコールの位置などを揃えることで可読性を向上させる

一貫性

ブロック等で段差の均等化

ブロック化

的に空行を入れることで上と下では異なる処理をしていることを明確に示す。

③コメント

その処理は何をしているのかといことを後から見てわかるようにコメントを入れることで、可読性をあげる。
また、メッセージを残すことも。。。

TODO: 他のファイルに同じ記述があるので共通化する
FIXME: メソッドが非推奨になったため使わないように変更する


最後に

今後更新していきブラッシュアップしていきますのでお手やわからにコメントしていただけると幸いです。