はじめに
プログラミング初心者に必見の、プログラムを読みやすくする方法をお伝えします。
以下の方を対象としています。
- 自分で書いたプログラムが汚くて、後で読んだときに読めない
- コードレビューでよく、ソースコードが汚いと指摘をもらう
- そもそも、ソースコードを読みやすくすることを考えてない
読みやすいコードを書くことで、以下の効果があります
- コードを追加/修正するスピードがアップ
- コードを他の人に読んでもらうときに、すらすら読んでもらえる
- 後でコードを読み返したときに、すらすら読める
特に、これから会社に入りプログラミングをする方は、おそらく読みやすくコードを書くということを学んでないことが多いと思います。会社に入り、プログラミングする場合は、正しく動くだけではなく、コードの読みやすさが重要になってきます。読みやすくコードがかけていると、それだけで先輩や上司の信頼につながるので読みやすいコードを書くことはオススメです！
この記事の内容は、Twitterでつぶやいた比較的短いネタを集めたものになります。
Twitterをご覧になっていない方は、良ければそちらもご覧ください。
Bool型の変数等の名前の付け方にこだわる
Bool型の変数等の名前の付け方、知ってますか？
～フラグとかで付けていくと乱立し、カオスな状態に陥るケースをよく見ます。
そのような状況を防ぐためにも、メジャーなBool型の命名規約をまとめたので良ければご覧ください。
メンバ変数はなるべく減らす
メンバ変数が多くなって、コードがぐちゃぐちゃになってないですか？
コードがぐちゃぐちゃにならないために、メンバ変数は減らしたほうがいいです。
メンバ変数が多くなると、複雑性が増すので、その解決方法等を1枚にまとめました。
変数名等の長さにこだわる
こんな悩みないでしょうか。
- 変数名が長くなってしまうけどいいのか
- 変数に使う単語は省略してよいのか
このような悩みを解決するための方法を一枚の以下の画像で紹介します！
ソースコードに意味のないコメントをつけるのをやめる
以下のようなことになってないでしょう。
- コメントの付け方がわからない
- なんとなくコメント付けている
そのような方に、意味のあるコメントを書くためのポイントを記載します！
「関数名」、「引数」、「戻り値」で、何をしているかわかるようにする
わかりやすい関数は、中の処理を見ないでもどのような処理をしているか想像できることです。そのためのポイントを記載します。
関数内の長さは短くするとわかりやすくなる
関数が長くなればなるほど、複雑になります。
1画面で見える程度がベストだと思います。
長くなりそうなら、関数にできる処理はないか、見つけて、別関数に分けると良いです。
また、静的解析ツール使用で簡単に確認できるためオススメです
変えない数は定数を使う
定数を使うと、定数に間違えて値を入れた場合に教えてくれます。
(言語によって、コンパイル時や実行時によってタイミングは変わります)
間違えたコードを書くのを防ぐためにも定数宣言は有効活用しましょう。
基本的には言語でサポートされていると思うので、サポートされている場合は使用しましょう。
※ 基本的にはconst宣言すれば使えるはず
また、定数名は基本的にすべて大文字、区切りは_で書きましょう
最後に
この記事は、定期的に更新していきますので、よろしくお願いします。
こちらの内容は、主に現場での実体験や書籍リーダブルコードや、コードコンプリートなどを参考にしています。
そちらの書籍の紹介は、以下の記事にまとめていますので、ご参考ください！
コメント