Java・命名規約の指針

基本的なルールはこちら

・半角のみを使用

Ｘ　→　class  // 全角は使えません
◯　→　ｃｌａｓｓ     // 全て半角で書かないといけない

"ｃｌａｓｓ"      // 文字や文字列としては全角を使用することができる
'あ'

・大文字と小文字は区別される

// これらは全て違う変数になる
int number;
int Number;
int NUMBER;

number = 1;   // 一番上だけに代入される

・使える記号は $ [ドル]と _ [アンダースコア]だけ

// 記号は $ か _ だけ
int month_number;   // この２つは基本的にはどこにでも何個でも付けれる
int $number;

int $____$;         // こんなのでも一応通る

他の記号は使えないと言うか、演算子とかで使うんで、ここで使うとおかしなことになってしまいますw

・数字は先頭に使用できない（それ以外ならOK）

悪）1sample　10month
良）sample1　year2month10

・予約語は使えない

char, int, float などのローカルや
String, Math などの参照型など、他にも多数あり。

・文字数の制限はない

これはそのままです、1文字から何文字でもOKです。

// こんな書き方はしないけど
// 例えば変数を例題総理大臣の文字列を格納する変数を宣言する場合
String rekidaiSouridaijinName  // これだけ長くても通るし
String n                       // １文字でも使うことはできる

ですが、こんな極端なものばかりだとどの変数がどこで使われているのか分からなくなり、可読性がどんどん下がっていしまいます。

みんなが使用している一般的な記述方法を覚えて起きましょう。

記述方法

Javaでは数種類の記法でプログラムを構成していきます。

主に使用するのはこちら

パスカルケース

全ての単語の先頭を大文字で書いてつなげる記法

例）SampleName    // sample と name の各単語の最初だけ大文字
   PascalCase   

キャメルケース

２つめの単語の先頭を大文字で書いてつなげる記法

例）sampleName　　　　// sample は小文字、2つ目のNameから
   camelCase

スネークケース

単語をアンダースコアでつなげる記法

例）SAMPLE_NAME　または　sample_name

この３つを各要素ごとに使い分けていきます。

命名規約の一覧

命名規約は以下の通りです

クラス・インターフェース

パスカルケースを使用。

メソッド・変数

キャメルケースを使用。

定数

スネークケースを使用。

メソッドの記述方法

メソッドは始めに動詞をつけて記述するとわかりやすいです。

例）sendItems　 →　アイテムを送る処理
　　addFile　　 →　ファイルを登録する処理
　  onClick　　 →　ボタンをクリックする処理

戻り値がboolean型の時は

「 is 」「 has 」「 can 」など状態を返す動詞を使用します。

略しすぎや長すぎは可読性の低下になります。

例１）
△　→　button //そのまま使っても問題ないが
◯　→　btn    //分かる範囲で略しても良い
Ｘ　→　b      //略しすぎると何を指しているのか分からなくなる

例２）
△　→　onStartButtonTapped    // 分かるけど長い
◯　→　onStartBtn             // 可読性を損なわずに省略する
Ｘ　→　stBtn                  // どんな機能か分からなくなる

コードの略称ですが、Javaでは本来は略さずに記述するのを良しとしています。

なので、略語を使う時はチーム内で統一させた方がいいでしょう。

ローマ字はやめた方がいいです。

Ｘ　→ namae     // 見慣れないので分かりにくい
　　　seigetsu
     nenrei 

◯　→ name      // 適正な英語にした方がわかりやすい
     sex
     age　

ローマ字に関しても会社やチームのプロジェクトによっては使っているところもあるみたいです。

だけどこれだと日本人しか読めなくなっちゃいますね（笑）

いろんな人が見ることを想定して、こういったルールは早いうちに慣れておいた方がいいでしょう。

対義語一覧

メソッドでよく使う言葉を集めて見ました。

対義語一覧

　左　・　右　　　／　　  left　・　right
　上　・　下　　　／　　   top　・　bottom
　動く・止まる　　／　　 start　・　stop
始める・終わる　　／　　 begin　・　end
上がる・下がる　　／　　    up　・　down
　次　・　前　　　／　　  next　・　preview
　読む・　書く　　／　　  read　・　write
　送信・　受信　　／　　  send　・　receive
　最初・　最後　　／　　 first　・　last
　追加・　削除　　／　　   add　・　remove
　挿入・　削除　　／　　insert　・　delete
　親　・　子　　　／　　parent　・　child
　開く・閉じる　　／　　  open　・　close
　押す・　引く　　／　　  push　・　pull
　古い・新しい　　／　　   old　・　new

他に使う単語の一覧です。

　 　単語　　：　意味

      get　：　取得
      set　：　設定
       is　：　〜かどうか
 listener　：　イベントリスナー
listeners　：　リスナーの配列
    focus　：　キーボード・マウスのフォーカス
     size　：　保持しているオブジェクトの個数
component　：　GUIコンポーネント
     name　：　名称
    mouse　：　マウス
    input　：　入力
   change　：　変更
traversal　：　順次処理
 property　：　プロパティ
      key　：　マップのキー
   create　：　生成
   update　：　更新
  enabled　：　有効
    paint　：　描画
    value　：　値
     text　：　文字列
      all　：　全て
   action　：　動作
    image　：　画像
       to　：　〜に変換
     type　：　種類
   bounds　：　境界
 location　：　場所

まだまだあるけどとりあえず良く使いそうなものだけ。

基本的なところですが、一般的な指針に早いうちに慣れて置かないとあとで色々と面倒なことになっちゃいます。

プログラミングを行う際には、自分が分かるコードを書くのではなく、他の人が見ても分かるコードを書くことが大事ですね。

以上、命名規約についてでした。