こんにちは、見えないプログラマです。
早いもので今年ラストのブログとなってしまいました。
今日は読みやすいプログラムについてすこし語ってみたいと思います。
プログラムは書くよりも読むことのほうが多いもので、例えば複数人で開発をしていると他人のプログラムを読んで処理やメソッドの使い方を理解すると言ったことがあります。また、自分の書いたプログラムでも数日経つとどうしてこうしたんだっけ？と忘れてしまうものです。
なので、読みやすい、わかりやすいプログラムを書くのは大切です。
そんな読みやすいプログラムを書くための方法をいくつか紹介します。(ただ、場合によっては最適な方法は異なってくるので、ちょうどいいやり方を工夫してみて下さい)
1. コーディング規則を作る
統一的なルールで書かれたプログラムは読みやすくわかりやすいです。ルールはプロジェクト内で統一されていればどのようなものでも良いと思いますが、使っているフレームワークや言語で一般的なルールを使うと後から参加した人でも馴染みやすく良いです。
コーディング規則ではざっくり次のようなルールが決まっています
- 変数やメソッドの名前の付け方
- インデントのやり方
2. マジックナンバーを排除する
よく言われるものですね。コード中に数字を直に書くのを無くします。
マジックナンバーは後からコードを読んだ際に「なんでこの数字にしたんだっけ？」となりがちです。他人が読んだらもはや意味不明ですね。
定数として外で定義する、必要に応じて意図を書いたコメントを添えてやると良いでしょう。
3. コメントを書く(適度に)
コメントを書きましょう。でも無意味に書くのは良くないです。「変数に代入する」、「数値をインクリメント」などは一目見ればわかりますからね。
次のようなポイントでコメントを書いてみましょう。
- メソッドや関数の使い方の説明
- 処理のひとかたまりごとにやっていることの説明
- 凝った処理の説明
他にもいろいろありますが今日はこんなところで失礼します。
このテーマについてはリーダブルコードという名著がありますので、そちらを読んでみるのも良いかと思います。
それでは良いお年をー
