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

背景

• PHPを想定して命名規則の参考になるサイトを見つけたのでまとめてみました。
• ルールの目的
  • 一定のルール化を行うことで、可読性が格段に上がりメンテナンス性が向上します。
  • 同じルールを知ることで、以下の分類だと認識して読めるので、読む側は楽になります。
  • 規則的なルールに基づくので美しさも増します。
  • 結果的には生産性が向上します。
• 特に
  • 一人で開発している時には利便性を感じないかもしれませんが、自分の書いたコードを誰かに見てもらう時に効果は絶大です。
  • エクリプスなど開発ツールに規約のルールのフォーマットを適用すれば、必ず統一されブレないのでベストだと思います。

基本

定数

• Example: MIN_VALUE
• すべて大文字
• 複合文字の場合は区切りをアンダースコア “_” で結合。（スネークケース記法）

クラス名(Pascal記法)

• Example: PermissionsIntro

1. 先頭を大文字
2. それ以外は小文字
3. 言葉の区切りは大文字

メソッド名(camelCase記法)

• Example: fileSend()

1. 先頭を小文字
2. 以降も小文字
3. 言葉の区切りは大文字

変数名（フィールド名）

• startDate

1. すべて小文字
2. 複合文字の場合は区切りをアンダースコア “_” で結合。（スネークケース記法）

用途別

boolean変数を返すメソッド

• Example: isEmpty()
• メソッド名が命題を表すように命名する
  1. is + 形容詞
  2. has + 過去分詞
  3. can + 動詞

フィールドの値に対する取得と設定メソッド

• Example: getCount()

1. フィールドの値を取得するメソッド: 先頭をget
2. フィールドの値を設定するメソッド: 先頭をset
3. 以降,camelCase記法

---

• 参考サイト
  • Java言語の命名指針 – Qiita