💬
[リーダブルコード]基礎
リーダブルコードとは
他の開発者が読みやすく、理解しやすいコードのことを指す。
"自分が読みやすい"ではなく、チーム開発が 会社ではメインであるため、
共通認識として読みやすいコードを書く必要がある。
リーダブルコードを書くことのメリット(なぜ必要か)
- コードの可読性が向上し、保守性や再利用性が高まる。
- コードレビューがしやすくなり、バグの発見や修正が容易になる。
- チーム開発においてコミュニケーションの効率が上がる。
- コードを書く時間や労力が減るため、生産性が向上する。
- より良いコードを書くことができるため、自己成長につながる。
1. 理解しやすい・可読性の良いコードをかく、ということ
- コードを書く際には、"自分"ではなく、"他の開発者が理解しやすいように書くこと"が重要。
具体的には...
1. 読みやすい命名規則の採用:
- 変数名や関数名、クラス名などをわかりやすく命名し、他の人がどんな処理をしているのかを想像しやすくする。
= "名前に情報を埋め込む"ということ.
=> 意識すべきは、
① 明確な単語を使用する / ② 汎用的な名前を避ける / ③ 不要な単語を捨てる
2. 適切なコメントの追加:
コードの意図や処理の説明をコメントで追加することで、他の人が理解しやすくなる。
ただし、余計なコメントや誤解を招くコメントは避けるべき!!!
3. インデントの整理:
コードを読みやすくするために、適切なインデントを使い、コードのブロックごとに改行を入れることで、
視覚的に整理されたコードを作成することができます。
4. 無駄なコードの削除:
不要なコードを削除することで、コードを簡潔にし、他の人がコードを理解するのに必要な情報だけに
集中することができるようにする。
2. テストコードの重要性
テストコードは、コードの品質を保証するために欠かせないもの。
以前にここにまとめたので省略します。
本を読んでも、記事を見ても、やはり経験が必要なので、今後も意識しながらアドバイスをもらい
リーダブルコードの練習を積みます!!!!
Discussion