リーダブルコード チートシート


はじめに

リーダブルコードを読み、
可読性の高いコーディングをするために
気をつけるべきポイントをメモしておきます

全体

  • 他人が最短で理解できるコードを書く

変数名

  • 他人が誤解せずに理解できる名前をつける
    • 明確な単語
    • 具体性
  • 名前に情報を詰め込む
    • フォーマット

コメント

  • 簡潔に
  • 当たり前、コードを読めばわかることはコメントしない
  • 自分の考え、理想をコメントする
    • 挙動が一致していないときに指摘できる
    • TODOなど、改善案件をコメントするのも良い
  • 読み手にとって何が必要かを考える
    • 定数にコメントをつける
    • ハマりそうなところを告知

定義

ロジック

条件式

ループ