この記事では、プログラミング初心者が押さえるべき「意図がわかる名前の付け方」を解説します。
名前を工夫するだけで、コードの読みやすさが向上し、開発の効率が格段にアップします。
新人エンジニアのタロウと先輩のアヤコの会話を通じて、実践的なコツを学んでいきましょう！
新人エンジニアのタロウが初めて取り組むプロジェクト。
彼の書いたコードをレビューした先輩のアヤコは、一つ気になる点を見つけた。
変数名が何を表しているのか全然わからない……。
これ、後からタロウ自身も苦労するんじゃないかな？
そんな思いを抱えながら、アヤコはタロウに助言することに決めた
――今日のテーマは「意図がわかる名前をつける」。さて、タロウはどんな学びを得るのでしょうか？
アヤコさん、先ほどレビューしてもらったコード、修正してみたんですが……。
これでいいでしょうか？
確認するね……。
うーん、全体的には良くなってるけど、名前の部分がまだ少し気になるかな。
名前ですか？
変数や関数の名前ってそんなに重要なんですか？
とても重要だよ。名前がわかりにくいと、後から自分も他の人もコードの意図を理解しづらくなるからね。たとえば、この変数xって何を表してるの？
えーっと、、あ、それは商品の価格です。
じゃあ、xじゃなくてitem_priceって名前にしてみたらどうかな？
具体的な名前にするだけで、コードがぐっと読みやすくなるよ。
なるほど……確かに、それなら一目でわかりますね。
他にはどんなルールがありますか？
意図がわかる名前をつけるコツ
名前をつけるときは、この3つを意識するといいよ。
「x」や「y」ではなく、「item_price」や「total_amount」のように、具体的な意味を持つ名前にする。
具体的な名前は、後から見直したときにコードの意図がわかりやすくなるからね。
「itm」や「qty」ではなく、「item」や「quantity」のようにフルネームを使うと誤解を防げる。
省略形は一見便利に思えるけど、他の開発者には意味が伝わらないことが多いからね。
「is_logged_in」「has_permission」のように、状態が一目でわかる名前をつける。
「動詞＋形容詞」の形式は、読みやすさと意図の明確さを両立させることができるよ。
じゃあ、関数の名前も気をつけた方がいいですよね？
その通り！関数名には動詞を使うと、何をする関数なのかが明確になるよ。
たとえば、calculate_total_priceとかね。
命名が変わるとこうなる！リファクタリング例
じゃあ、タロウくんの最初のコードをリファクタリングしてみようか。
元のコードはこれだね。
リファクタリング前
x = 100 y = 200 z = x + y print(z)
これを具体的な名前に変えると……こうなるよ。
リファクタリング後
item_price = 100 tax_amount = 200 total_price = item_price + tax_amount print(total_price)
おぉ！同じ処理なのに、全然わかりやすいですね！
でしょ？これなら他の人が見ても、何を計算しているかすぐにわかるよ。
今日からできる命名の習慣
名前をつけるのって、こんなに大事だなんて知りませんでした。
今日から意識します！
その調子！
小さなことだけど、命名を工夫するだけでコード全体の品質がぐっと上がるよ。
これからも一緒にがんばろうね。
こうして、タロウは名前の付け方の大切さを学び、よりわかりやすいコードを書けるよう一歩前進した。
意図がわかる名前をつけることは、初心者だけでなく、ベテランにとっても欠かせないスキルだ。
タロウのように日々の工夫を積み重ねて、あなたも読みやすく、誇れるコードを書いていこう
――次回もお楽しみに！
コメント