Top > コーディング規約 > 命名規則

命名規則

コーディング規約の基本は、命名規則です。命名規則の目的は、以下の2点です。

  • 一目で意味が分かる
  • 一目でスコープが分かる

せっかくなので、具体的なソースコードを例にして、読みやすくなっていく様子を
みてもらおうと思います。

ダメダメなソース

簡単なファイルコピーを行うソースコードを例に挙げます
ネーミング規則だけでなく、あえてダメダメなコードにしています。

さて、どのあたりがダメダメでしょうか?
ネーミング規則の目的から検証してみましょう。

一目で意味が分かる

  • run()メソッドって、何するか分かります?
  • s1, s2 って、何のことか分かります?( 新人さん曰く、stream1, stream2 )
  • 同じくf1, f2も、名前だけでは何かわかりませんね...( 新人さん曰く、file1, file2 )

一目でスコープが分かる

  • byte[] b = new byte[i]; の i って、どこで値を決めているの?
  • run メソッドだけ見ると、f1, f2 っていつ値が決まるの?

ネーミング規則が適当だと、その変数やメソッドが、何を表しているかを理解するために
ソースの全行を読まないといけなくなります。
確かに、全部読めば書いているわけですが、時間の無駄だと思いませんか?

ネーミング規則

では、管理人が推奨するネーミング規則を適用して、ソースを書き換えて見ましょう。

一目で意味が分かるために

  • メソッド、変数共に、意味が分かる名前にしましょう。名前は長くなっても構わない。
  • メソッド名はできるだけ、「動詞+名詞」にしましょう。
  • つづりはらくだ記法を使います。意味の区切り目を大文字にします

一目でスコープが分かるために

  • スコープ接頭語をつけます。( static変数には "s", メンバ変数には "m", 引数には "a" )
  • 定数定義は、全部大文字で、らくだ記法の適用外とし、意味の区切り目は _ とする

修正版ソース

では、上記の命名規則を踏まえて、ソースを書き直してみます

どうでしょうか。元のソースと見比べてください。
どの1行を見ても、だいたい何をしているか想像がつきやすくなったはずです。

このようにしておけば、他人のソースを読むことになっても、ざっと流れを
把握することが容易になり、チーム全体の生産性を向上させることにつながります。