【ヨシュアツリー原則】良い名前をつけなければ、それは見えない

joshuatree-principle
ヨシュアツリー原則

“ヨシュアツリー”という名前を知れば、それが見えるようになる

人は、名前を得ることで、その存在を発見する、というのがこの原則の由来です。

ある青年の物語
ある青年が図書館に訪れた。
なにげに手に取った図鑑。「ヨシュアの木」という木を見つける。
ふしぎな形の珍しい木。「こんな木は見たことがないな」。
ところが図書館からの帰り道、この木がたくさん生えていることを発見する。

似たような例は、だれしも覚えがあるはず。

  • この車かっこいいなーと思って街中に出たら、そこらじゅうに走っている。
  • このお菓子おいしいなーと思って店にいったら、どの店でも売っている。
目次

どんなときに使える?

「あれ」とか「これ」とか多いとき

リーダーさん

あのクラスの、この表示がおかしいところ、ほらあの時のやり方でできないかしら…

イケイケくん

なに言ってるかさっぱり分からないっす!

プログラミングでは、「なにかを指す言葉」が、いろいろ必要になります。

ファイル、関数、変数、パッケージ、チーム、プロジェクト、方法、問題、アイデア…ほんとうにいろいろ。

そうすると、「あれ」とか「これ」とか言っちゃったり、なんか適当な名前つけちゃったりしがち。

プログラムに良い名前をつけよう

名前を考え抜こう

ファイル、関数、変数、パッケージ。お茶を濁さず、名前を考えましょう。

考えなし名前の例
  • doWork関数 いったい何する関数なの?
  • exeFlag変数 なにするフラグなの?
  • Commonパッケージ なにが入ってるの?

本職プログラマーなら、関数名ひとつとってもどんな名前がベストなのか考えます

世の中にも、名前のつけ方の指針がいろいろあります。参考にしてみましょう。

ローマ字は避けよう

クラス名や関数名、ローマ字で書いたりすると、

ベテランさん

名前にローマ字を使うなぁーーーー!

と怒られます。

実際、プログラミング言語が英語的だから、ローマ字入ると読みにくいです。英語で書きましょうね。

すでにある名前も調べよう

新しいアイデアかと思ったら、それは世の中にすでにあるものだった、ということもあります。

新人くん

Javaで、定義ファイルを読み込める便利クラスを作りましたよー

リーダーさん

それ、Propertiesクラスで出来るんだけど…

画期的なアイデアを思いついた!」というときがあるかもしれません。

思いついたそのアイデアの 99% は、たぶん世の中にすでにあります。

世の中の情報にも、アンテナを立てましょう。

「問題」に名前をつけよう

問題を話すときは、その問題に名前をつけて呼びましょう

プログラミングでは、エラー出たり、動かなかったり、次々と問題がでてきます。そのとき、つい「あの問題」とか言っちゃう。そうすると話が合わなくなります。

もう、「〇〇問題」とかでもいいから、とにかく問題になにか名前をつけることをおススメします。

リーダーさん

○○クラスの「表示の下側欠ける問題」直せないかしら?

イケイケくん

了解っす!

まとめ

こういった原則名とか、欧米のかたは名前をつけるのが上手ですよね(原則名とか)。

名前は、やもするとプロジェクトの成否に関わるくらい重要。考えに考え抜きましょう。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

CAPTCHA


目次