この記事の趣旨
自分の学習のメモとして残します。
どなたかのお役に立てたら光栄です。
こんな方におすすめです
・コードが見づらいと言われる
・初心に返りたい
このような方には何か発見があると思います。
読みやすいコードとは？
ズバリ『良いコード』のこと。
良いコードは、他人がそのコードを見た時に短時間で理解できるコードのことを言います。
逆に、分かりづらい・理解しづらいコードは解読に時間がかかります。それだけ開発の工数もかかってしまい、効率が良くありません。
では、良いコードの条件・要素を紐解いていきましょう！
●コードの命名に規則を
変数やメソッドは好きなように命名ができます。
ルールがありませんので、個人の好きなようにできます。
特に共同開発の現場などでは、「他人が見てわかる」を意識する必要があります。
◎命名のポイント
【目的がわかる単語を使う】
例）new → new_account
【汎用的な名前は避ける】
・一時的な変数などは避ける
・可読性を意識して
【名前に情報を含める】
大文字、小文字をルールに沿って活用
【誤解されない名前を使う】
・何がしたいかが明確な名前
・説明的に長くなっても良いので、可読性重視
例）read_books → already_read_books
●コードレイアウト
プログラムの挙動に影響はないが、可読性を大幅にあげることができる
◎レイアウトのポイント
・整列 ：縦列を揃える。イコールの位置など縦が揃うと見やすい
・一貫性 ：似たような構造は同じフォーマットに統一できないか検討
・ブロック化 ：同じ系統の変数などをまとめてグループ化すること
●コメント
・プログラムの動作を説明
・他の開発者がコードを読む際の理解を助ける
※多すぎても読むのに時間がかかるため、簡潔に
◎コメントのポイント
・理由をコメントする ：なぜそのコードを書いたか
・他の開発者へメモを残す：開発中のメモとして
・実際の例を記入する ：コメントでは伝わりづらい時は、コメントとしてコードを記載
まとめ
結局大事なことは
「人に対する思いやり」だなぁと。
複数人で仕事をする以上、「自分だけ良ければそれで良い」という考えはNG。
誰もが見やすく、仕事をしやすい状況を自分が作り出す意識が大切。
そのための知識や技術であると思う。
これからしっかり学んでいきましょう。