パッケージ名、名前空間
- 全て小文字にする。
- ドメインを逆にする。
例:test.hogehoge.comであれば、com.hogehoge.testというパッケージ名にする。
クラス名
- 先頭、言葉の区切りは大文字にする。
- それ以外は小文字にする。
- 動詞が入っているクラス名は避ける(動作はメソッドで表現するため)
例:PersonalData
Webアプリ関連
単語 | 用途 |
---|---|
~Logic | ビジネスロジックを記述したメソッドに付ける。 |
~DAO | DAOクラスに付ける。 |
メソッド名
- 先頭は小文字にする。
- 言葉の区切りのみ大文字にする。
- 先頭に以下の表のように、処理名の英単語を付ける。
- 先頭に「動詞」を入れる。
単語 | 用途 |
---|---|
check~ | チェックする |
add~ | 追加する |
show~ | 表示する。 |
is~ | 真偽値(Boolean)を返す。(オブジェクトが期待する状態になっているか判定) |
has~ | 真偽値(Boolean)を返す。(オブジェクトが値を持っているか判定) |
can~ | 真偽値(Boolean)を返す。(オブジェクトが動作できるか判定) |
validate~ | 正しい状態か判定する。 |
initialize~ | 初期化する。 |
show~ | 表示する。 |
print~ | 描く |
remove~ | 削除する。 |
stop~ | 強制停止する。 |
break~ | 一時停止する。 |
start~ | 止まっていた処理を再開する。 |
begin~ | 開始する。 |
end~ | 終了する。 |
DAO関連
単語 | 用途 |
---|---|
find~ | SELECT文 |
└findBy(テーブル名) | テーブル名から、データをSELECTする。 |
~All | 全件 |
変数名
大事なのは英文法的に正しく記載されているかになります。
ループのインデックス名
iやjなどと一文字でつけるのではなく、item_idxなどとつける。
名詞
users
形容詞+名詞
favorite_fluets
過去分詞+名詞
hashed_password
名詞+過去分詞
users_joined_in_group
is+動詞
is_open
has+名詞
has_password
この記事へのコメントはありません。