学習記録
読みやすいコードの書き方
【目的】
・自分で読みやすいコードを描けるようにすること
【学習概要】
関数名・変数名の命名
複雑なロジックを避けたコードを書く
有効なコメントを書く
【学習内容】
1.読みやすいコードの必要性
生産性・保守性の向上
柔軟な開発体制が構築できる
1−1.読みやすいコード
変数名(関数名)が他者から見ても分かりやすい
複雑なロジックがない
コメントが記載されていて全体像が把握しやすい
1−1①.分かりやすい関数名・変数名
具体的な名前をつけること
例)const addTask
const userId
1ー1②.複雑なロジックの回避(リファクタリング)
❶ネスト中のネストを避ける
例)ifのなかにifを記述しない
❷条件式はあらかじめ関数化しておき、それを呼び出す形で記述する
❸複雑な条件式を分解して、複数のif文にわける
1−2.コメントで正確な情報をつたる
コメントを残す場面
・複雑なロジックを記述した場合、処理の概要と自分の考えをコメントで残す
・なぜその処理をしているかコメントを残す
コメントを残すべきでない場面
・コメントの補足コメント(コメントは一文にする)
・複雑なソースコードを補足するコメント(複雑なソースコードを修正する方を優先)
おわり