「このdata2って、何のデータだっけ？」
自分で付けた名前なのに、数日後には意味が分からなくなった経験はありませんか。コードやファイルの名前づけは小さな作業に見えますが、曖昧な名前は確認や説明の時間を増やします。
迷いにくい名前を付けるポイントは、中身ではなく「何に使うものか」を表すことです。
曖昧な名前は、未来の手戻りを増やす
作業中は内容を覚えているため、data1やdata2のような短い名前でも困らないかもしれません。
しかし、翌週に見直したり、別の担当者が作業を引き継いだりすると、名前だけでは用途を判断できません。その結果、コードの中身を調べたり、作成者に確認したりする時間が発生します。
名前を短く付けて節約した数秒よりも、後から意味を調べる時間のほうが長くなることがあります。
「何が入っているか」より「何に使うか」
名前づけに迷ったときは、「何が入っているか」だけでなく、「何に使うものか」を考えてみましょう。
例えば、メールの情報が入っているデータにdata2と付けても、用途は分かりません。一方、次のような名前なら役割を想像しやすくなります。
data2：何のデータか分からない送信待ちメール：これから送信するメールだと分かる
役割が名前に含まれていれば、詳しい説明がなくても次の作業へ進みやすくなります。
これは、難しい命名規則を覚える話ではありません。「初めて見る人が、何に使うものか判断できるか」という基準で考えるだけです。
ファイル名にも同じ考え方が使える
この考え方はプログラミングだけでなく、日常のファイル管理にも使えます。
例えば、次のようなファイル名が並んでいると、どれを開けばよいか迷います。
- 最新版
- 最新版2
- 本当の最新版
- 最終版の修正版
代わりに、用途や状態が分かる言葉を入れてみましょう。
- 顧客確認用
- 社内レビュー用
- 提出用
- 修正中
日付や案件名と組み合わせれば、さらに探しやすくなります。大切なのは、単に「新しいファイル」と示すのではなく、「誰が何に使うファイルか」を表すことです。
良い名前は小さな引き継ぎになる
分かりやすい名前には、説明の一部を代わりに伝える働きがあります。
役割が読める名前なら、同僚だけでなく、時間がたった後の自分も作業を再開しやすくなります。名前づけに少し時間を使うことは、未来の確認や手戻りを減らすための準備ともいえるでしょう。
完璧な名前を目指す必要はありません。迷ったときは、次の一問だけで十分です。
「この名前を初めて見る人は、何に使うものか分かるだろうか？」
まとめ
コードやファイルの名前は、短ければよいとは限りません。中身だけでなく役割が伝わる名前にすると、確認や説明にかかる時間を減らせます。
まずは今日作るファイルや変数の一つだけでも、「これは何に使うものか」が読める名前に変えてみてください。良い名前は、未来の自分や次の担当者に残せる小さな引き継ぎになります。
コメント