いもづる オブジェクト指向

変数には意味のわかる名前を

少しくらい長くてもいい、意味のわかる名前を付けましょう。

プログラムは暗号ではなく読み物です。 省略された変数名や、意味の汲めない名前ではソースコードを見てもそこでの理解ができません。 些細なことでも、プログラムを「解析する」という形をとることになります。 コメントを探しにいったり、インテリセンスに頼ったりせず、読み進められるコーディングをしよう。 プログラム → プログラム言語 → 言語 ですから。

以前の改修作業でのことです。
巨大なクラスのprivate変数で fileName という名のString変数が、 「ファイル名称」/「ファイルのフルパス」/「ファイルの存在するディレクトリパス」の3つの内容で使いまわされていました。 あらゆるメソッドから変数に値が設定されていて、いつどれが設定されるのか、今ここでは何なのか全くわからない状態でした。
これがせめて hogeFileName, hegeFilePath, fugoDirPath などという名で個別の変数になっていれば・・・。 缶詰状態で大変な時期でした「こんなことでハマッっている時間はない!」、「ここは頭を使うところじゃない!」 と何度苛立ち解析をやり直したことか。。。

これは、名前の問題プラス使いまわされているという更に悪い状態ですが、変数1つにほんと泣かされた1例です。

この変数なんだっけ?と、些細なことで思考が途切れなくていいように、「わかる名前」を付けましょう。その方が楽です。

 

webmaster@e-ioo.net